Welcome to Georiviere’s documentation!

Install

You need docker installed. Docker-compose is recommended in the configuration below.
Optional : if you want to use external database, prepare a postgresql 10+ postgis2.5+ database with postgis and postgis_raster enabled, and a dedicated user.

You can use external database by commenting postgres container and volume references in docker-compose.yml, and set variables :

You can use external nginx proxy. Edit provided nginx conf file and comment nginx references in docker-compose.yml. Fix web:8000 to 127.0.0.1:8000 in nginx.conf.

unzip install.zip
cd georiviere

mv .env.dist .env

-> Set all required values

docker-compose run --rm web bash -c "exit"

Set your var/conf/custom.py if required (as geotrek overlay, some settings should be set BEFORE database initialization)
Init database and project config
```
docker-compose run --rm web update.sh
```

Create your super user

docker-compose run --rm web ./manage.py createsuperuser

To get local environment working, we recommend to use a custom domain, as ‘georiviere.local’. Define it in your /etc/hosts.

Copy the env dist file

cp .env.dist .env

Set required values, for postgres database access

docker-compose up

docker-compose run --rm web ./manage.py test

docker-compose run coverage run ./manage.py test
docker-compose run coverage report -m

We use sphinx doc and sphinx-rtd-theme.

Requirements are included.

To compile and test documentation on local environment, run :

docker-compose run --workdir /opt/georiviere-admin/docs --rm web make html