Updated Readme
All checks were successful
Run Tests on Code / run-tests (push) Successful in 13s

This commit is contained in:
Neshura 2024-04-10 23:28:23 +02:00
parent 55748f30fb
commit add30dcfdd
Signed by: Neshura
GPG key ID: B6983AAA6B9A7A6C

View file

@ -10,12 +10,11 @@ Any changes there will persist updates and supersede the default config. The Sys
#### User Configuration
DomainLink currently expects redirect files to be placed in any home directory, specifically `/home/{user}/.config/domainlink/config.toml`.
DomainLink currently expects redirect files to be placed in any home directory, specifically `/home/{user}/.config/domainlink/domains.toml` or `/root/.config/domainlink/domains.toml`.
Redirects are configured in an array, below is an example config.
```toml
[[domain_configs]]
domains = ["sub.domain.tld", "sub2.domain.tld"]
target = "https://sub.domain.tld/query"
```
By default, DomainLink does not create any redirect rules, you will have to create these yourself.
Support for `/root/.config/domainlink/redirects` may come in the future.
By default, DomainLink does not create any redirect rules, you will have to create these yourself.