This commit is contained in:
parent
5a46d3722b
commit
5fcdddde03
1 changed files with 19 additions and 1 deletions
20
README.md
20
README.md
|
@ -1,3 +1,21 @@
|
|||
# DomainLink
|
||||
|
||||
Lightweight tool for handling (sub-)domain to URL redirects instead of having to deal with copy and pasting proxy rules.
|
||||
Lightweight tool for handling (sub-)domain to URL redirects instead of having to deal with copy and pasting proxy rules.
|
||||
|
||||
#### System Configuration
|
||||
|
||||
The package provides a default configuration in `/usr/share/local/domainlink/config.toml`.
|
||||
Modifying this is not recommended as updates may override any changes, instead make a copy at `/etc/domainlink/config.toml`.
|
||||
Any changes there will persist updates and supersede the default config. The System Config only contains the settings for listen addresses and ports.
|
||||
|
||||
#### User Configuration
|
||||
|
||||
DomainLink currently expects redirect files to be placed in any home directory, specifically `/home/{user}/.config/domainlink/config.toml`.
|
||||
Redirects are configured in an array, below is an example config.
|
||||
```toml
|
||||
[[domain_configs]]
|
||||
domains = ["sub.domain.tld", "sub2.domain.tld"]
|
||||
target = "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.
|
Loading…
Reference in a new issue