Skip to content

Commit 5572ed4

Browse files
DOCS: add Config section
1 parent 4ecda8c commit 5572ed4

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,27 @@ deno task start --server full
206206
- `--seo` - Currently the default is to only use the build with no seo enabled. This flag enables the seo build.
207207
- Domain must be set in the [config](#config)
208208
- Overrides the enabled option in the [config](#config)
209+
210+
---
211+
212+
## Config
213+
214+
- Incognito currently uses a config file in the toml format.
215+
- An example of this file can be found [here](https://github.com/titaniumnetwork-dev/incognito/blob/main/config.example.toml)
216+
217+
##### Build Opts
218+
| Type | Default | Description | Can be overwritten by ENV var |
219+
|------|---------|------------------------------------|-------------------------------|
220+
| games | `true` | Disables or enables the games page | - [ ] - No |
221+
222+
##### Server
223+
| Type | Default | Description | Can be overwritten by ENV var |
224+
|------|---------|-----------------------------------------------------------------------------------------------------------------|------------------------------|
225+
| port | `8000` | Change the default port. *Note: the environment var `PORT` takes precedence* | - [x] - Yes |
226+
| wisp | `true` | Disable or enables the in built wisp server. *Note: when using the Hono server there is no built-in wisp server | - [ ] - No |
227+
228+
##### SEO
229+
| Type | Default | Description | Can be overwritten by ENV var |
230+
---------|-------------------------|--------------------------------------------------------------------------|-------------------------------|
231+
| SEO | `false` | Change whether or not to enabled SEO | - [x] - Yes - `SEO` (as well via a CLI flag `--seo` |
232+
| DOMAIN | `http://localhost:8000` | When the `both` option is enable, only show the SEO stuff on this domain | - [x] - Yes - `DOMAIN` |

0 commit comments

Comments
 (0)