aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLia Lenckowski <lialenck@protonmail.com>2023-08-23 19:16:29 +0200
committerLia Lenckowski <lialenck@protonmail.com>2023-08-23 19:16:29 +0200
commit33bc8bfb247f4fcbfc206bdeb9c0e118e961ba59 (patch)
tree498bf05cd0c1ea0d65f314e6f56877cd2fb9c4a4 /README.md
parent1e52fa4df63352835ea3020c727ea6093779e176 (diff)
downloadfastbangs-33bc8bfb247f4fcbfc206bdeb9c0e118e961ba59.tar
fastbangs-33bc8bfb247f4fcbfc206bdeb9c0e118e961ba59.tar.bz2
fastbangs-33bc8bfb247f4fcbfc206bdeb9c0e118e961ba59.tar.zst
document config file; small fixes in default config & build system
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4047bf0..9e98f7a 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,9 @@ The server keeps its own list of bangs, initialized with those from duckduckgo.
There is a public instance running at [search.metamuffin.org](https://search.metamuffin.org), running on a server in germany.
## Configuration
-Configuration is done through environment variables. The following may be used:
+Configuration is done through environment variables, or a file named "fastbangs.yaml" sitting in the working directory of the server. Running `make` will include a default config.
+
+If you go with environment variables, the following options are available:
- PORT: port to bind to. Default: 20546
- BIND\_ADDR: address to bind to. Default: any ipv4/ipv6 interface
- BASE\_URL: url of the deployed website, without trailing slash. Default: "http://localhost:20546"