aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2023-04-04 11:15:03 +0200
committermetamuffin <metamuffin@disroot.org>2023-04-04 11:15:03 +0200
commit99d1ab55dfb1714d8f574060e618dc93c94f245c (patch)
treeb01f6ccb6b4060f120a71145fbbded0131c9430e /readme.md
parent84587df365c61297e08d00f28317b452681a4b84 (diff)
parentfe36a0640f2e36baad1f08033f09b49bdd0f1062 (diff)
downloadkeks-meet-99d1ab55dfb1714d8f574060e618dc93c94f245c.tar
keks-meet-99d1ab55dfb1714d8f574060e618dc93c94f245c.tar.bz2
keks-meet-99d1ab55dfb1714d8f574060e618dc93c94f245c.tar.zst
Merge branch 'master' of codeberg.org:metamuffin/keks-meet
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 94a1ca0..92b4a3f 100644
--- a/readme.md
+++ b/readme.md
@@ -30,14 +30,20 @@ For trying it out, a hosted version is available on
pacman -S --needed deno rustup make coreutils; rustup install nightly
git clone https://codeberg.org/metamuffin/keks-meet.git
cd keks-meet
+cp config/client.example.toml config/client.toml # use the example config. the defaults work.
make run # or `make build`
```
When changing code, use `make watch` to re-build things automatically as needed.
(run `cargo install systemfd cargo-watch` if needed)
+The client configuration file (`config/client.toml`) configures the client and
+requires server recompilation on change for now.
+
The server's bind address can be controlled using the `BIND` environment
-variable.
+variable. In production you can also activate the `standalone` feature to embed
+all assets into the binary; This speeds it up and allows the server to run from
+just the binary.
If you use this project or have any suggestions, please
[contact me](https://metamuffin.org/contact)