diff options
| author |  thursday <xthursdayx@mailbox.org> | 2021-07-13 09:23:31 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2021-07-13 09:23:31 -0400 |
| commit | 1b7a2cd14f494df1d0b834dd218cc2da50ccc0df (patch) | |
| tree | c347e6ba45acae8f6db2ce55e9314b5f3626c175 /README.md | |
| parent | Update docker-compose.yml (diff) | |
| download | ferdium-server-1b7a2cd14f494df1d0b834dd218cc2da50ccc0df.tar.gz ferdium-server-1b7a2cd14f494df1d0b834dd218cc2da50ccc0df.tar.zst ferdium-server-1b7a2cd14f494df1d0b834dd218cc2da50ccc0df.zip | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 2 insertions, 3 deletions
| @@ -41,7 +41,7 @@ The easiest way to set up Ferdi server on your server is with Docker. | |||
| 41 | The Docker image can be run as is, with the default SQLite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). | 41 | The Docker image can be run as is, with the default SQLite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). |
| 42 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate. | 42 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate. |
| 43 | 43 | ||
| 44 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and local, the internal contianer port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) and the example [docker-compose.yml](./docker/docker-compose.yml) for more information. | 44 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and location, the internal container port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) and the example [docker-compose.yml](./docker/docker-compose.yml) for more information about migrating to the new image. |
| 45 | 45 | ||
| 46 | 1. Pull the Docker image | 46 | 1. Pull the Docker image |
| 47 | 47 | ||
| @@ -75,8 +75,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p | |||
| 75 | -e CONNECT_WITH_FRANZ=true \ | 75 | -e CONNECT_WITH_FRANZ=true \ |
| 76 | -e DATA_DIR=data \ | 76 | -e DATA_DIR=data \ |
| 77 | -p <port>:3333 \ | 77 | -p <port>:3333 \ |
| 78 | -v <path to data>:/config \ | 78 | -v <path to data>:/data \ |
| 79 | -v <path to database>:/app/database \ | ||
| 80 | -v <path to recipes>:/app/recipes \ | 79 | -v <path to recipes>:/app/recipes \ |
| 81 | --restart unless-stopped \ | 80 | --restart unless-stopped \ |
| 82 | getferdi/ferdi-server | 81 | getferdi/ferdi-server |