Skip to content

Commit 6965e9e

Browse files
Alfagun74Alfagun74
committed
add missing config docs
1 parent 48babfd commit 6965e9e

File tree

3 files changed

+1192
-857
lines changed

3 files changed

+1192
-857
lines changed

‎docs/server-docs/configuration.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,11 @@ This page describes the various configuration properties used in the application
9191

9292
| Property | Description | Default | Possible Values |
9393
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | --------------- |
94+
| `GAMES_INDEX_USE_POLLING` | Whether to use polling for the file watcher instead of native filesystem events. Useful for network shares (NFS/SMB) or huge libraries where native events might not work. | `false` | `true`, `false` |
9495
| `GAMES_INDEX_INTERVAL_IN_MINUTES` | The index interval, measured in minutes, decides how frequently the server should check for changes in games in the `/files` directory. This used to be essential before we implemented the filewatcher to the server. Nowadays, it's optional for rare situations where the filewatcher might miss changes. If set to 0, it won't regularly trigger reindexing and solely depend on the filewatcher. | `60` | Any number |
9596
| `GAMES_SUPPORTED_FILE_FORMATS` | Comma-Separated list of supported file-types GameVault should detect. | [All Supported Formats](structure.md#supported-archive-formats) | ".zip,.7z,.rar" |
9697
| `GAMES_SEARCH_RECURSIVE` | If indexer should search for games in subfolders. | `true` | `true`, `false` |
98+
| `GAMES_INDEX_CONCURRENCY` | The number of concurrent indexing tasks. | `1` | Any number |
9799
| `GAMES_DEFAULT_ARCHIVE_PASSWORD` | A default password for archives. Useful if you always use the same password for your games and want Game Type Detection to work with the encrypted files. Without this, game type detection on encrypted archives depends on the file extension and whether the headers are encrypted. | `Anything` | Any string |
98100

99101
## MEDIA
@@ -132,6 +134,7 @@ This page describes the various configuration properties used in the application
132134
| `AUTH_ACCESS_TOKEN_EXPIRES_IN` | Specifies how long an access token is valid. | `5m` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
133135
| `AUTH_REFRESH_TOKEN_EXPIRES_IN` | Specifies how long a refresh token is valid. | `30d` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
134136
| `AUTH_BASIC_AUTH_ENABLED` | Enables or disables Basic Auth. Disabling this will disable registering and logging in using username and password. | `true` | `true`, `false` |
137+
| `AUTH_API_KEY_ENABLED` | Enables or disables API Key authentication. | `false` | `true`, `false` |
135138
| `AUTH_OAUTH2_ENABLED` | Enables or disables OAuth2 integration. | `false` | `true`, `false` |
136139
| `AUTH_OAUTH2_SCOPES` | A comma-separated list of OAuth2 scopes to request. | `openid,email,profile` | Any comma-separated list of scopes |
137140
| `AUTH_OAUTH2_AUTH_URL` | The OAuth2 authorization endpoint URL provided by your Identity Provider. Refer to your IdP's documentation for the specific URL. | - | Any valid URL |
@@ -143,9 +146,10 @@ This page describes the various configuration properties used in the application
143146

144147
## TESTING
145148

146-
| Property | Description | Default | Possible Values |
147-
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------- |
148-
| `TESTING_AUTHENTICATION_DISABLED` | If `true`, the API will accept any auth header and impersonate a user. Useful for testing without authentication. | `false` | `true`, `false` |
149-
| `TESTING_MOCK_FILES` | If `true`, the server will mock all files or ignore filesystem functionalities. Useful for testing without real files. | `false` | `true`, `false` |
150-
| `TESTING_IN_MEMORY_DB` | If `true`, the server will use an in-memory database. Useful for testing without creating an actual database. Only works with SQLITE. | `false` | `true`, `false` |
151-
| `TESTING_MOCK_PROVIDERS` | If `true`, the server will create two mock providers. (-9999 and 9999 Priority) Useful for testing metadata-merges. | `false` | `true`, `false` |
149+
| Property | Description | Default | Possible Values |
150+
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------- |
151+
| `TESTING_AUTHENTICATION_DISABLED` | If `true`, the API will accept any auth header and impersonate a user. Useful for testing without authentication. | `false` | `true`, `false` |
152+
| `TESTING_MOCK_FILES` | If `true`, the server will mock all files or ignore filesystem functionalities. Useful for testing without real files. | `false` | `true`, `false` |
153+
| `TESTING_IN_MEMORY_DB` | If `true`, the server will use an in-memory database. Useful for testing without creating an actual database. Only works with SQLITE. | `false` | `true`, `false` |
154+
| `TESTING_MOCK_PROVIDERS` | If `true`, the server will create two mock providers. (-9999 and 9999 Priority) Useful for testing metadata-merges. | `false` | `true`, `false` |
155+
| `TESTING_LOG_HTTP_TRAFFIC_ENABLED` | If `true`, the server will log all incoming and outgoing HTTP traffic. (Except Healthchecks) | `false` | `true`, `false` |

‎package.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,25 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@cmfcmf/docusaurus-search-local": "^1.2.0",
18-
"@docusaurus/core": "3.8.1",
19-
"@docusaurus/plugin-client-redirects": "^3.8.1",
20-
"@docusaurus/preset-classic": "3.8.1",
21-
"@docusaurus/theme-common": "^3.8.1",
22-
"@headlessui/react": "^2.2.8",
17+
"@cmfcmf/docusaurus-search-local": "^2.0.1",
18+
"@docusaurus/core": "3.9.2",
19+
"@docusaurus/plugin-client-redirects": "^3.9.2",
20+
"@docusaurus/preset-classic": "3.9.2",
21+
"@docusaurus/theme-common": "^3.9.2",
22+
"@headlessui/react": "^2.2.9",
2323
"@mdx-js/react": "^3.1.1",
2424
"clsx": "^2.1.1",
2525
"docusaurus-plugin-image-zoom": "^3.0.1",
2626
"prism-react-renderer": "^2.4.1",
2727
"react": "^18.0.0",
2828
"react-dom": "^18.0.0",
29-
"swetrix": "^3.7.1"
29+
"swetrix": "^3.7.2"
3030
},
3131
"devDependencies": {
32-
"@docusaurus/module-type-aliases": "3.8.1",
33-
"@docusaurus/types": "^3.8.1",
34-
"@tailwindcss/postcss": "^4.1.13",
35-
"autoprefixer": "^10.4.21",
32+
"@docusaurus/module-type-aliases": "3.9.2",
33+
"@docusaurus/types": "^3.9.2",
34+
"@tailwindcss/postcss": "^4.1.18",
35+
"autoprefixer": "^10.4.23",
3636
"postcss": "^8.5.6",
3737
"postcss-import": "^16.1.1",
3838
"prop-types": "^15.8.1",

0 commit comments

Comments
 (0)