docs: add cookie_domain information

Zibbp · Aug 29, 2024 · b1fa217 · b1fa217
1 parent d9fc165
commit b1fa217
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -86,35 +86,36 @@ The `docker-compose.yml` file has comments for each environment variable. The `*
 
 ##### API
 
-| ENV Name                        | Description                                                                                                                   |
-| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| `DEBUG`                         | Enable debug logging `true` or `false`.                                                                                       |
-| `VIDEOS_DIR`                    | Path inside the container to the videos directory. Default: `/data/videos`.                                                   |
-| `TEMP_DIR`                      | Path inside the container where temporary files are stored during archiving. Default: `/data/temp`.                           |
-| `LOGS_DIR`                      | Path inside the container where log files are stored. Default: `/data/logs`.                                                  |
-| `CONFIG_DIR`                    | Path inside the container where the config is stored. Default: `/data/config`.                                                |
-| `TZ`                            | Timezone.                                                                                                                     |
-| `DB_HOST`                       | Host of the database.                                                                                                         |
-| `DB_PORT`                       | Port of the database.                                                                                                         |
-| `DB_USER`                       | Username for the database.                                                                                                    |
-| `DB_PASS`                       | Password for the database.                                                                                                    |
-| `DB_NAME`                       | Name of the database.                                                                                                         |
-| `DB_SSL`                        | Whether to use SSL. Default: `disable`. See [DB SSL](https://github.com/Zibbp/ganymede/wiki/DB-SSL) for more information.     |
-| `DB_SSL_ROOT_CERT`              | _Optional_ Path to DB SSL root certificate. See [DB SSL](https://github.com/Zibbp/ganymede/wiki/DB-SSL) for more information. |
-| `JWT_SECRET`                    | Secret for JWT tokens. This should be a long random string.                                                                   |
-| `JWT_REFRESH_SECRET`            | Secret for JWT refresh tokens. This should be a long random string.                                                           |
-| `TWITCH_CLIENT_ID`              | Twitch application client ID.                                                                                                 |
-| `TWITCH_CLIENT_SECRET`          | Twitch application client secret.                                                                                             |
-| `FRONTEND_HOST`                 | Host of the frontend, used for CORS. Example: `http://192.168.1.2:4801`                                                       |
-| `OAUTH_ENABLED`                 | _Optional_ Wheter OAuth is enabled `true` or `false`. Must have the other OAuth variables set if this is enabled.             |
-| `OAUTH_PROVIDER_URL`            | _Optional_ OAuth provider URL. See https://github.com/Zibbp/ganymede/wiki/SSO---OpenID-Connect                                |
-| `OAUTH_CLIENT_ID`               | _Optional_ OAuth client ID.                                                                                                   |
-| `OAUTH_CLIENT_SECRET`           | _Optional_ OAuth client secret.                                                                                               |
-| `OAUTH_REDIRECT_URL`            | _Optional_ OAuth redirect URL, points to the API. Example: `http://localhost:4000/api/v1/auth/oauth/callback`.                |
-| `MAX_CHAT_DOWNLOAD_EXECUTIONS`  | Maximum number of chat downloads that can be running at once. Live streams bypass this limit.                                 |
-| `MAX_CHAT_RENDER_EXECUTIONS`    | Maximum number of chat renders that can be running at once.                                                                   |
-| `MAX_VIDEO_DOWNLOAD_EXECUTIONS` | Maximum number of video downloads that can be running at once. Live streams bypass this limit.                                |
-| `MAX_VIDEO_CONVERT_EXECUTIONS`  | Maximum number of video conversions that can be running at once.                                                              |
+| ENV Name                        | Description                                                                                                                                                                                                                                                                               |
+| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `DEBUG`                         | Enable debug logging `true` or `false`.                                                                                                                                                                                                                                                   |
+| `VIDEOS_DIR`                    | Path inside the container to the videos directory. Default: `/data/videos`.                                                                                                                                                                                                               |
+| `TEMP_DIR`                      | Path inside the container where temporary files are stored during archiving. Default: `/data/temp`.                                                                                                                                                                                       |
+| `LOGS_DIR`                      | Path inside the container where log files are stored. Default: `/data/logs`.                                                                                                                                                                                                              |
+| `CONFIG_DIR`                    | Path inside the container where the config is stored. Default: `/data/config`.                                                                                                                                                                                                            |
+| `TZ`                            | Timezone.                                                                                                                                                                                                                                                                                 |
+| `DB_HOST`                       | Host of the database.                                                                                                                                                                                                                                                                     |
+| `DB_PORT`                       | Port of the database.                                                                                                                                                                                                                                                                     |
+| `DB_USER`                       | Username for the database.                                                                                                                                                                                                                                                                |
+| `DB_PASS`                       | Password for the database.                                                                                                                                                                                                                                                                |
+| `DB_NAME`                       | Name of the database.                                                                                                                                                                                                                                                                     |
+| `DB_SSL`                        | Whether to use SSL. Default: `disable`. See [DB SSL](https://github.com/Zibbp/ganymede/wiki/DB-SSL) for more information.                                                                                                                                                                 |
+| `DB_SSL_ROOT_CERT`              | _Optional_ Path to DB SSL root certificate. See [DB SSL](https://github.com/Zibbp/ganymede/wiki/DB-SSL) for more information.                                                                                                                                                             |
+| `JWT_SECRET`                    | Secret for JWT tokens. This should be a long random string.                                                                                                                                                                                                                               |
+| `JWT_REFRESH_SECRET`            | Secret for JWT refresh tokens. This should be a long random string.                                                                                                                                                                                                                       |
+| `TWITCH_CLIENT_ID`              | Twitch application client ID.                                                                                                                                                                                                                                                             |
+| `TWITCH_CLIENT_SECRET`          | Twitch application client secret.                                                                                                                                                                                                                                                         |
+| `FRONTEND_HOST`                 | Host of the frontend, used for CORS. Example: `http://192.168.1.2:4801`                                                                                                                                                                                                                   |
+| `COOKIE_DOMAIN`                 | _Optional_ Domain the cookie is valid for. This is used with a reverse proxy and should be the top level domain (e.g. `domain.com`). You may need to tinker with this variable depending how your reverse proxy is setup. Typically it is the root where ganymede is or the level up-one. |
+| `OAUTH_ENABLED`                 | _Optional_ Wheter OAuth is enabled `true` or `false`. Must have the other OAuth variables set if this is enabled.                                                                                                                                                                         |
+| `OAUTH_PROVIDER_URL`            | _Optional_ OAuth provider URL. See https://github.com/Zibbp/ganymede/wiki/SSO---OpenID-Connect                                                                                                                                                                                            |
+| `OAUTH_CLIENT_ID`               | _Optional_ OAuth client ID.                                                                                                                                                                                                                                                               |
+| `OAUTH_CLIENT_SECRET`           | _Optional_ OAuth client secret.                                                                                                                                                                                                                                                           |
+| `OAUTH_REDIRECT_URL`            | _Optional_ OAuth redirect URL, points to the API. Example: `http://localhost:4000/api/v1/auth/oauth/callback`.                                                                                                                                                                            |
+| `MAX_CHAT_DOWNLOAD_EXECUTIONS`  | Maximum number of chat downloads that can be running at once. Live streams bypass this limit.                                                                                                                                                                                             |
+| `MAX_CHAT_RENDER_EXECUTIONS`    | Maximum number of chat renders that can be running at once.                                                                                                                                                                                                                               |
+| `MAX_VIDEO_DOWNLOAD_EXECUTIONS` | Maximum number of video downloads that can be running at once. Live streams bypass this limit.                                                                                                                                                                                            |
+| `MAX_VIDEO_CONVERT_EXECUTIONS`  | Maximum number of video conversions that can be running at once.                                                                                                                                                                                                                          |
 
 ##### Frontend
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -26,6 +26,7 @@ services:
       - TWITCH_CLIENT_ID= # from your twitch application
       - TWITCH_CLIENT_SECRET= # from your twitch application
       - FRONTEND_HOST=http://IP:PORT # URL to the frontend service. Needs to be the 'public' url that you visit.
+      #- COOKIE_DOMAIN= # Optional domain that the cookies will be set to. Should be the top level domain with a reverse proxy (e.g. `domain.com`).
       # Worker settings. Max number of tasks to run in parallel per type.
       - MAX_CHAT_DOWNLOAD_EXECUTIONS=3
       - MAX_CHAT_RENDER_EXECUTIONS=2