Skip to content

Commit

Permalink
Add note on config file usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ohsayan committed Dec 7, 2023
1 parent fcd16b6 commit 2cf0ce5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/system/1.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ endpoints:
port: 2003
```
:::info Starting the server with a configuration file
To start the server with a configuration file, simply run `skyd --config <path to config>.yaml`
:::

Here's an explanation of all the keys:
- `system`:
- `mode`: set to either `dev` / `prod` mode. `prod` mode will generally make some things stricters (such as background services)
Expand Down

0 comments on commit 2cf0ce5

Please sign in to comment.