cwinfo/yggdrasil-network.github.io
5
0
Fork 0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2025-02-28 19:51:34 +00:00
Code Releases Activity

Formatting tweak

Browse Source
This commit is contained in:
Neil Alexander 2018-12-09 12:47:16 +00:00
parent ae2be52601
commit a355c2958a
No known key found for this signature in database
GPG Key ID: A02A2019A2BB0944
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
configuration.md
View File

@ -16,22 +16,22 @@ If you installed Yggdrasil through one of the platform packages (i.e. macOS, Deb
Otherwise, you can generate a configuration file in the following ways:
- HJSON: `yggdrasil -genconf > /etc/yggdrasil.conf`
- JSON: `yggdrasil -genconf -json > /etc/yggdrasil.conf`
- **HJSON**: `yggdrasil -genconf > /etc/yggdrasil.conf`
- **JSON**: `yggdrasil -genconf -json > /etc/yggdrasil.conf`
## Using Configuration
Yggdrasil can accept a configuration file either through `stdin` or by being given a path on the filesystem to a configuration file:
- Using `stdin`: `yggdrasilctl --useconf < /etc/yggdrasil.conf`
- Using file: `yggdrasilctl --useconffile /etc/yggdrasil.conf`
- **Using `stdin`**: `yggdrasilctl --useconf < /etc/yggdrasil.conf`
- **Using file:** `yggdrasilctl --useconffile /etc/yggdrasil.conf`
## Normalising Configuration
If you want to see the original format of the configuration file, or convert between HJSON and JSON formats, you can use the `-normaliseconf` option, e.g.
- Convert from HJSON to JSON: `yggdrasilctl -normaliseconf -useconffile /etc/yggdrasil.conf -json`
- Convert from JSON to HJSON: `yggdrasilctl -normaliseconf -useconffile /etc/yggdrasil.conf`
- **Convert from HJSON to JSON**: `yggdrasilctl -normaliseconf -useconffile /etc/yggdrasil.conf -json`
- **Convert from JSON to HJSON**: `yggdrasilctl -normaliseconf -useconffile /etc/yggdrasil.conf`
Normalising the configuration also adds any missing configuration items with their default values. This can be useful when upgrading to a newer version of Yggdrasil that adds new configuration options. Many of our distribution packages normalise the configuration automatically during upgrade.