Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix various smaller issues in docker compose example and docker Readme.md #97

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Fix various smaller issues in docker compose example and docker Readme.md #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To create the docker container with the proper parameters:

docker create \
--name=ferdium-server \
-e NODE_ENV=development \
-e NODE_ENV=production \
-e APP_URL=<ferdium-server-url> \
-e DB_CONNECTION=<database> \
-e DB_HOST=<yourdbhost> \
Expand All @@ -55,9 +55,10 @@ To create the docker container with the proper parameters:
-e IS_REGISTRATION_ENABLED=true \
-e CONNECT_WITH_FRANZ=true \
-e DATA_DIR=/data \
-e JWT_USE_PEM=true \
-p <port>:3333 \
-v <path to data>:/data \
-v <path to recipes>:/app/recipes \
-v <path to recipes>:/app/build/recipes \
--restart unless-stopped \
ferdium/ferdium-server:latest

Expand All @@ -70,15 +71,15 @@ The server will be launched at [http://localhost:3333/](http://localhost:3333/)

## Configuration

Container images are configured using parameters passed at runtime (such as those above). An explanaition of the default parameters is included below, but please see [the Docker documentation](https://docs.docker.com/get-started/overview/) for additional information.
Container images are configured using parameters passed at runtime (such as those above). An explanation of the default parameters is included below, but please see [the Docker documentation](https://docs.docker.com/get-started/overview/) for additional information.

<strike>If any environment parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike>
**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environment variables to your container at runtime. **

| Parameter | Function |
| :----: | --- |
| `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information about port mapping |
| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environment variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) |
| `-e NODE_ENV=production` | for specifying Node environment: `production` (recommended) or `development` |
| `-e APP_URL=<ferdium-server-url>` | for specifying the URL of the Ferdium-server, including `http://` or `https://` as relevant. |
| `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is `sqlite`, see [below](#supported-databases-and-drivers) for other options |
| `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is `127.0.0.1` |
Expand All @@ -99,8 +100,9 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is `true` |
| `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is `true` |
| `-e DATA_DIR=/data` | for specifying the SQLite database folder, default is `/data` |
| `-v <path to data on host>:/data` | this will store Ferdium-server's data (its database, among other things) on the docker host for persistence. See the [Docker docs](https://docs.docker.com/storage/volumes/) for more information on the use of container volumes |
| `-v <path to recipes on host>:/app/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |
| `-e JWT_USE_PEM=true` | create JWT public/private keys if `true` |
| `-v <path to data on host>:/data` | this will store Ferdium-server's data (its database, among other things) on the docker host for persistence |
| `-v <path to recipes on host>:/app/build/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |

By enabling the `CONNECT_WITH_FRANZ` option, Ferdium-server can:
- Show the full Franz recipe library instead of only custom recipes
Expand Down Expand Up @@ -137,7 +139,7 @@ If you are an existing Ferdium-server user using the built-in `SQlite` database,
| `-e DATA_DIR=/app/database` | existing Ferdium-server users who use the built-in sqlite database should add this environment variable to ensure data persistence |
| `-v <path to data on host>=/app/databases` | existing Ferdium-server users who use the built-in sqlite database should use the volume name `/app/database` |

If you are an existing Ferdium-server user who uses an external database or different variables for the built-in `SQlite` database, you should updatae your parameterse acordingly. For example, if you aree using an exterenal MariaDB or MySql database your unique parameters might look like this:
If you are an existing Ferdium-server user who uses an external database or different variables for the built-in `SQlite` database, you should update your parameters accordingly. For example, if you are using an external MariaDB or MySql database your unique parameters might look like this:
| Parameter | Function |
| :----: | --- |
| `-e DB_CONNECTION=mysql` | for specifying the database being used |
Expand All @@ -147,7 +149,7 @@ If you are an existing Ferdium-server user who uses an external database or diff
| `-e DB_PASSWORD=ferdiumpw` | for specifying the database password|
| `-e DB_DATABASE=adonis` | for specifying the database to be used|
| `-v <path to database>:/app/database` | this will store Ferdium-server's database on the docker host for persistence |
| `-v <path to recipes>:/app/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |
| `-v <path to recipes>:/app/build/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |

**In either case, please be sure to pass the correct variables to the new Ferdium-server container in order maintain access to your existing database.**

Expand Down
7 changes: 4 additions & 3 deletions docker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version: "2"
services:
ferdium-server:
image: ferdium-server
image: ferdium/ferdium-server:latest
container_name: ferdium-server
environment:
- NODE_ENV=development
- APP_URL=localhost
- NODE_ENV=production
- APP_URL=<ferdium-server-url>
- DB_CONNECTION=sqlite
- DB_HOST=127.0.0.1
- DB_PORT=3306
Expand Down Expand Up @@ -34,3 +34,4 @@ services:
restart: unless-stopped
volumes:
ferdium-recipes-vol:
ferdium-database-vol:
Loading