better documentation

This commit is contained in:
lesion
2019-08-06 01:12:05 +02:00
parent 60edcbb970
commit 689b4d0a76
29 changed files with 261 additions and 823 deletions

View File

@@ -6,29 +6,41 @@ parent: Install
---
## Install with docker
**You do not need to clone the full repo as we distribute gancio via npm.**
[Dockerfile](https://git.lattuga.net/cisti/gancio/raw/docker/docker/Dockerfile) and [docker-compose.yml](https://git.lattuga.net/cisti/gancio/raw/docker/docker/docker-compose.yml) are the only needed files.
A [Dockerfile](https://git.lattuga.net/cisti/gancio/raw/docker/docker/Dockerfile) and a docker-compose.yml are the only files needed.
1. Create a directory where everything related to gancio is stored (db, images, config)
```bash
mkdir /opt/gancio
cd /opt/gancio
```
:information_source: you can choose a different directory of course
:information_source: <small>you can choose a different directory.</small>
### Using postgreSQL
1. Download docker-compose.yml and Dockerfile
```bash
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/Dockerfile
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.yml
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.postgresql.yml -O docker.compose.yml
```
1. Create an empty configuration file (db.sqlite only needed for sqlite
setup)
1. Create an empty configiguration (**this is needed**)
```
touch config.json
```
### Using sqlite
1. Download docker-compose.yml and Dockerfile
```bash
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/Dockerfile
wget https://git.lattuga.net/cisti/gancio/raw/master/docker/docker-compose.sqlite.yml -O docker-compose.yml
```
1. Create an empty db and config (**this is needed**)
```
touch config.json db.sqlite
```
<small>After first setup, you can edit `config.json` file and restart the container on your needs.</small>
### Finish
1. Build docker image and launch interactive setup in one step
```
@@ -40,6 +52,8 @@ docker-compose run --rm gancio gancio setup --docker
docker-compose up -d
```
1. [Setup nginx as a proxy](/setup/nginx)
1. [Setup nginx as a proxy](/install/nginx)
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you specified during setup and enjoy :tada:
1. You can edit `config.json` file and restart the container on your needs, see [Configuration](/config) for more details.