ProfessionalUwU/echoip-slatecave
1
0
Fork 0
mirror of https://codeberg.org/slatian/service.echoip-slatecave.git synced 2025-01-13 20:17:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Small foramtting improvements

Browse Source
This commit is contained in:
Slatian 2023-08-06 04:03:14 +02:00
parent cc6bbba3e4
commit 1013c5365a
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Configuration.md
View File

@ -14,9 +14,9 @@ The configuration file consists of multiple sections of options grouped by featu
The default configuration tries to be working out of the box while providing as little security footguns as possible. Have a look at the `server` and `dns` sections that is where most security related options are.
## server
## [server]
### listen_on
### `listen_on`
Configures the bind address and port the service will listen on.
@ -24,7 +24,7 @@ It uses the format `<ip-address>:<port>`, for the ip-address use `127.0.0.1` for
This option can be overridden by the `-l <ip-address>:<port>` option on the commandline.
### ip_header
### `ip_header`
Configures which http header that contains the real client IP-Address or tells the service to use the IP-Address used to connect to it when in use without a proxy server.
@ -36,25 +36,25 @@ When using without a reverse Proxy set to `ConnectInfo`.
Please keep in mind that the ratelimit depends on the IP-Address being non-spoofable which is only given if the setting here matches the one of your proxy.
### allow_private_ip_lookup
### `allow_private_ip_lookup`
Defaults to `false`, set to `true` to allow looking up IP-Addresses that fall into the private IP-Range. Enabling is not recommended when the server is publically accessible.
### static_location
### `static_location`
When specified allows overriding the location where echoip-slatecave serve static files from (the default is the `static` directory under the [template_location](#template_location) )
## dns
## [dns]
### allow_forward_lookup
### `allow_forward_lookup`
When set to `true`, allows resolving Domain names over the webinterface for every configured dns resolver.
### allow_reverse_lookup
### `allow_reverse_lookup`
When set to `true`, allows looking up domain names for IP-Addresses using reverse dns lookups for every configured resolver.
### hidden_suffixes
### `hidden_suffixes`
Configure it with a list of suffixes of domin names you don't want to leak out to the web interface.
@ -90,7 +90,7 @@ In case you want to use the system resolver and customize it.
`system_resolver_weight`
: Equivalent to the `weight` of a custom resolver, default: 1000
### search
### `search`
This is for a work in progress feature that allows confiuring search domains for all custom dns resolvers.
@ -148,7 +148,7 @@ protocol = "tls"
tls_dns_name = "dns3.digitalcourage.de"
```
## geoip
## [geoip]
These options configure paths to maxmind (or compatible) databses. The Official databases are available after signing up on [maxmind.com](https://maxmind.com). (In case someone knows a similar source of IP to geolocation mapping under a less propritetary license please contact me.)
@ -165,19 +165,19 @@ location_database = "mmdb/GeoLite2-City.mmdb"
Note: When echoip-slatecave rececieves a `SIGUSR1` posix signal it will attempt to reload the mmdb files. This is useful for keeping the databses up to date without having to restart the service.
## template
## [template]
### template_location
### `template_location`
This option contains the path to the direcotry containing the templates. It is overridden by the `-t <template-location>` command line option.
It can contain a glob pattern, bit make sure to configure the [`static_location`](#static_location) if it does.
### extra_config
### `extra_config`
This points to the toml file containing the configuration for the template itself, its content depends on what the template expects. This option is overridden by the `-e <extra-config>` command line option.
### text_user_agents
### `text_user_agents`
A list of Prefixes of UserAgents that should be served plain text by default.
@ -188,7 +188,7 @@ Example:
text_user_agents = ["curl/"]
```
## ratelimit
## [ratelimit]
Configure a Quota for the Rate limiter.
@ -196,6 +196,7 @@ Note: The ratelimiter depends on the [ip_header](#ip_header) setting to be coore
`per_minute`
: Integer of how many requests are allowed (and regnerate) per minute.
`burst`
: Integer of how many requests are additionally allowed.