gancio-upstream/docs/install/docker.md
2021-07-08 22:50:21 +02:00

3 KiB

layout title permalink parent nav_order
default Docker /install/docker Install 2

Docker installation

{: .no_toc }

  1. TOC {:toc}

Initial setup

  • You must have the following dependencies installed: Docker, Docker Compose and Nginx
  1. Install docker
  2. Install docker-compose
  3. Install nginx
  • Create a directory where everything related to gancio is stored
mkdir -p /opt/gancio
cd /opt/gancio

Use sqlite

  1. Download docker-compose.yml and Dockerfile
wget {{site.url}}{% link /docker/Dockerfile %}
wget {{site.url}}{% link /docker/entrypoint.sh %}
wget {{site.url}}{% link /docker/sqlite/docker-compose.yml %}
  1. Build docker image and launch interactive setup
docker-compose build
docker-compose run --rm gancio gancio setup --docker --db=sqlite

Use postgreSQL

  1. Download docker-compose.yml and Dockerfile
wget {{site.url}}{% link /docker/Dockerfile %}
wget {{site.url}}{% link /docker/entrypoint.sh %}
wget {{site.url}}{% link /docker/postgres/docker-compose.yml %}
  1. Build docker image and launch interactive setup
docker-compose build
docker-compose run --rm gancio gancio setup --docker --db=postgres

Start gancio

  1. Run your container
docker-compose up -d
  1. Look at logs
tail -f  data/logs/gancio.log
  1. Navigate away from Gancio directory & into Nginx Directory
cd ~
cd /etc/nginx/sites-available
  1. [Setup nginx as a proxy]({% link install/nginx.md %})

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

  3. Edit data/config.json and restart the container on your needs, see [Configuration]({% link install/configuration.md %}) for more details.

Upgrade

warning "Backup your data" Backup your data is generally a good thing to do and this is especially true before upgrading. Don't be lazy and [backup]({% link install/backup.md %}) your data!

error "Upgrade from a version < 1.0" Since v1.0 our docker setup is changed and a new container has to be built:

  1. cd /opt/gancio
  2. [Backup your data]({% link install/backup.md %})
  3. Download new Dockerfile
    wget {{site.url}}{% link /docker/Dockerfile %}
  4. Download new entrypoint.sh
    wget {{site.url}}{% link /docker/entrypoint.sh %}
  5. Download new docker-compose.yml (substitute sqlite with postgres in case):
    wget {{site.url}}{% link /docker/sqlite/docker-compose.yml %}
  6. Build the new container docker-compose build
  7. Extract your backup into ./data
    mkdir data; tar xvzf gancio-<yourLastBackup>-backup.tgz -C data
  8. Stop your old container docker-compose stop
  9. Start your new container docker-compose up
cd /opt/gancio
docker-compose up -d --no-deps --build