eost_gissmo_tools/README.md
2016-01-14 16:32:45 +01:00

54 lines
1.3 KiB
Markdown

# Gissmo Launch Script
This script, called **Gissmo Launcher**, aims to manage Docker containers while working on Gissmo project (Cf. https://github.com/eost/gissmo/).
It's not a part of previous Github's branch because of its current private state. I hope this will change.
## Requirements
I suggest you to check these points befaure using Gissmo Launcher:
* docker
* bash (Bourne Again Shell)
* tput command (try ```which tput``` to know if you have it)
* a default configuration file to give Gissmo Launcher some data
## Configuration file
Just copy *config.example* file to *config* one:
cp ./config.example ./config
It should work.
If any problem, have a look into *config.example* file in which all possible parameters are given.
## Usage
Just do:
./launch.sh
It will display you a list of available commands.
## Examples
Here is an example on how I frequently use Gissmo Launcher:
launch.sh init
launch.sh create
launch.sh restore ~/2015.05.06.dump
launch.sh migrate
launch.sh dev
launch.sh stop
launch.sh start python manage.py shell
launch.sh stop
## A different configuration file
If you want to use another configuration file than current, use the **GISSMO_CFG** variable as:
GISSMO_CFG=~/new_config launch.sh
It will use *new_config* file instead.