diff options
| author | Lia Lenckowski <lialenck@protonmail.com> | 2023-08-20 20:43:27 +0200 |
|---|---|---|
| committer | Lia Lenckowski <lialenck@protonmail.com> | 2023-08-20 20:43:27 +0200 |
| commit | 11bc80ddb4c5fabdd199b03f35c8977380a0c618 (patch) | |
| tree | 3b251e1a96948580bd028774d598bfa51ee4321a /README.md | |
| parent | 28290ac9e4aaed9a605bfec734818c28dd4ff51a (diff) | |
| download | fastbangs-11bc80ddb4c5fabdd199b03f35c8977380a0c618.tar fastbangs-11bc80ddb4c5fabdd199b03f35c8977380a0c618.tar.bz2 fastbangs-11bc80ddb4c5fabdd199b03f35c8977380a0c618.tar.zst | |
document options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -3,3 +3,15 @@ This project functions as a meta search engine, resolving shortcuts to other sea The server keeps its own list of bangs, initialized with those from duckduckgo. Users are thus able to submit their own bangs on the website, which need to be approved by an administrator before coming into effect for all users. 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: +- 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" +- ADMIN\_USER: username for logging into the interface for accepting/rejecting bangs. Default: "bleb" +- ADMIN\_PW\_HASH: hash of the passwort used for logging in. Default: "" + +On the password hash: +The default setting makes it impossible to log in, forcing you to set your own. You DON'T NEED TO DO THIS if you don't plan on adding custom bangs. The format is the sha512 hash of the password, converted to base64. +You can generate a password using the following command: `echo -n YOUR_PASSWORD | sha512sum | awk '{print $1}' | xxd -r -p | base64 | tr -d '\n'` |