panorama/docs/src/config.md

28 lines
767 B
Markdown
Raw Normal View History

2021-02-24 12:50:27 +00:00
# Config
2021-03-09 00:32:01 +00:00
Configuration is done by editing `$XDG_CONFIG_HOME/panorama/panorama.toml`.
This is usually found somewhere like `$HOME/.config/panorama/panorama.toml` It
2021-02-24 12:50:27 +00:00
follows the [TOML][1] file format, and the data structures are defined in code
at `src/config.rs`.
Example configuration:
```toml
version = "0.1"
[[mail]]
imap.server = "mail.example.com"
imap.port = 143
imap.tls = "starttls"
imap.auth = "plain"
imap.username = "foo"
imap.password = "bar"
```
As one of the primary goals of panorama, the application should automatically
detect changes made to this file after it has started, and automatically
re-establish the connections required. As a result, there's no UI for editing
the configuration within the application itself.
[1]: https://toml.io/en/