Table of contents

  1. Initial setup
  2. Use sqlite
  3. Use postgreSQL
  4. Start gancio
  5. Upgrade

Initial setup

You do not need to clone the full repo as we distribute gancio via npm.
A Dockerfile and a docker-compose.yml are the only files needed.

  • Create a directory where everything related to gancio is stored (db, images, config)
    mkdir /opt/gancio
    cd /opt/gancio
    

    note that you can choose a different directory.

Use sqlite

  1. Download docker-compose.yml and Dockerfile
    wget https://gancio.org/docker/Dockerfile
    wget https://gancio.org/docker/sqlite/docker-compose.yml
    
  2. Create an empty db and config (this is needed)
    touch config.json db.sqlite
    mkdir user_locale
    
  3. Build docker image and launch interactive setup in one step
    docker-compose build
    docker-compose run --rm gancio gancio setup --docker --db=sqlite
    

Use postgreSQL

  1. Download docker-compose.yml and Dockerfile
    wget https://gancio.org/docker/Dockerfile
    wget https://gancio.org/docker/postgres/docker-compose.yml
    
  2. Create an empty configuration (this is needed)
    touch config.json
    mkdir user_locale
    
  3. Build docker image and launch interactive setup in one step
    docker-compose build
    docker-compose run --rm gancio gancio setup --docker --db=postgres
    

Start gancio

  1. Run your container
    docker-compose up -d
    
  2. Look at logs with
    docker-compose logs
    
  3. Setup nginx as a proxy

  4. Point your web browser to http://localhost:13120 or where you specified during setup and enjoy :tada:

  5. You can edit config.json file and restart the container on your needs, see Configuration for more details.

Upgrade

cd /opt/gancio
docker-compose up -d --no-deps --build