From d20e2dada5b206d1ac79c91e1a7962084a8be6d8 Mon Sep 17 00:00:00 2001 From: lesion Date: Wed, 26 Jan 2022 15:38:53 +0100 Subject: [PATCH] update docker install docs --- docs/install/docker.md | 51 +++++++++++------------------------------- 1 file changed, 13 insertions(+), 38 deletions(-) diff --git a/docs/install/docker.md b/docs/install/docker.md index 2acd4802..38c5aef9 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -11,76 +11,51 @@ nav_order: 2 1. TOC {:toc} -## Initial setup - - -- __You must have the following dependencies installed: Docker, Docker Compose and Nginx__ +## Setup +Make sure to have [Docker Engine](https://docs.docker.com/engine/install/), +[Docker Compose](https://docs.docker.com/compose/install/) and [nginx](https://nginx.org/en/docs/install.html) installed: ```bash sudo apt install docker docker-compose nginx ``` -or -1. [Install docker](https://docs.docker.com/engine/install/) -1. [Install docker-compose](https://docs.docker.com/compose/install/) -1. [Install nginx](https://nginx.org/en/docs/install.html) -- __Create a directory where everything related to gancio is stored__ +Create a directory where everything related to gancio is stored: ```bash mkdir -p /opt/gancio cd /opt/gancio ``` -## Use sqlite -
- -1. **Download docker-compose.yml and Dockerfile** +Download `Dockerfile` and `entrypoint.sh`: ```bash 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 -``` -docker-compose build -``` -
- -## Use postgreSQL -
- -1. **Download docker-compose.yml and Dockerfile** +Download `docker-compose.yml` choosing your preferred database dialect between `sqlite`, `postgres` and `mariadb`: ```bash -wget {{site.url}}{% link /docker/Dockerfile %} -wget {{site.url}}{% link /docker/entrypoint.sh %} -wget {{site.url}}{% link /docker/postgres/docker-compose.yml %} +DB=sqlite +wget {{site.url}}/docker/$DB/docker-compose.yml ``` -1. Build docker image -``` +Build docker image +```bash docker-compose build ``` -
- ## Start gancio -1. Run your container +Start your container: ```bash docker-compose up -d ``` -1. Look at logs +You can take a look at logs using: ```bash tail -f data/logs/gancio.log ``` -1. [Setup nginx as a proxy]({% link install/nginx.md %}) +You'll need to [setup nginx as a proxy]({% link install/nginx.md %}) then you can point your web browser to your domain :tada: -1. Point your web browser to your domain :tada: - -1. Edit `data/config.json` and restart the container on your needs, see [Configuration]({% link install/configuration.md %}) for more details. ## Upgrade