diff options
| author | Lia Lenckowski <lialenck@protonmail.com> | 2023-08-25 16:57:08 +0200 |
|---|---|---|
| committer | Lia Lenckowski <lialenck@protonmail.com> | 2023-08-25 16:57:08 +0200 |
| commit | a68afb81885ffdf0d6fe58df5aee57d7e7653ee9 (patch) | |
| tree | 8fdc6506e8b4769e83f6ce1d40df785ab5c7dfe7 | |
| parent | 464fa0f067dfa49680c152260425463cc64581a4 (diff) | |
| download | fastbangs-a68afb81885ffdf0d6fe58df5aee57d7e7653ee9.tar fastbangs-a68afb81885ffdf0d6fe58df5aee57d7e7653ee9.tar.bz2 fastbangs-a68afb81885ffdf0d6fe58df5aee57d7e7653ee9.tar.zst | |
document build process
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -4,6 +4,14 @@ 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. +## Building +The build-time dependencies are curl, make, esbuild, sassc, and stack. Under arch linux, you may install these with `paru -Syu make esbuild sassc stack-static`, replacing `paru` with your AUR-helper of choice. + +With these installed, run `make`. This will take a few minutes, but recompiling after an update should be quick. + +## Running +Building leaves you with a directory named `deploy`. Copy this onto the machine you want to run the server on and run the `fastbangs` executable found inside, using the `deploy` directory as your working directory. + ## Configuration 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. |