Skip to content

Commit e32d854

Browse files
committed
docs: Add default config to README
1 parent 0f20fc8 commit e32d854

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ Currently implemented features:
3030
* JSON, Protobuf, Flatbuffers and Boblight server
3131
* Black border detector, color channel adjustments, smoothing
3232

33-
## Migrating your settings
33+
## Configuration
34+
35+
### Migrating your settings
3436

3537
This rewrite uses the same database format for storing settings. In order to
3638
load your existing hyperion.ng settings, assuming you are in your home
@@ -44,6 +46,31 @@ $ mkdir -p .config/hyperion.rs/
4446
$ cp .hyperion/db/hyperion.db .config/hyperion.rs/
4547
```
4648

49+
### Using a TOML file
50+
51+
You may also configure hyperion.rs using a TOML representation of the configuration. To generate the initial file, you can use the `--dump-config` option:
52+
53+
```bash
54+
$ hyperiond-rs --dump-config >config.toml
55+
```
56+
57+
Then, you can start the daemon using this config file:
58+
59+
```bash
60+
$ hyperiond-rs --config config.toml
61+
```
62+
63+
The minimal configuration required is as follows:
64+
65+
```toml
66+
[instances.0.instance]
67+
friendlyName = 'Test instance'
68+
enabled = true
69+
70+
[instances.0.device]
71+
type = 'dummy'
72+
```
73+
4774
## Running hyperion.rs
4875

4976
Once your settings database has been migrated, you can run hyperion.rs using

0 commit comments

Comments
 (0)