diff options
author | metamuffin <metamuffin@disroot.org> | 2023-04-05 09:13:30 +0200 |
---|---|---|
committer | metamuffin <metamuffin@disroot.org> | 2023-04-05 09:13:30 +0200 |
commit | 8b198d7244d45140bcc7e211cd8811043a856455 (patch) | |
tree | 9563204bf4be8612b33f8e2a1be51fa9e26f845c /readme.md | |
parent | bfeb96146309e1f92e2d3f040a0ee874131ed90c (diff) | |
download | keks-meet-8b198d7244d45140bcc7e211cd8811043a856455.tar keks-meet-8b198d7244d45140bcc7e211cd8811043a856455.tar.bz2 keks-meet-8b198d7244d45140bcc7e211cd8811043a856455.tar.zst |
update readme
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 15 |
1 files changed, 8 insertions, 7 deletions
@@ -24,26 +24,27 @@ only. See [COPYING](./COPYING). ## Usage For trying it out, a hosted version is available on -[my server](https://meet.metamuffin.org/). For self-hosting, this should help: +[meet.metamuffin.org](https://meet.metamuffin.org/). For self-hosting, this +should help: ```sh -pacman -S --needed deno rustup make coreutils; rustup install nightly +pacman -S --needed esbuild 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` +make install # binaries will be copied to ~/.cargo/bin ``` When changing code, use `make watch` to re-build things automatically as needed. -(run `cargo install systemfd cargo-watch` if needed) +(might require `cargo install systemfd cargo-watch`) 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. 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. +variable. In production you can also activate the `standalone` feature (enabled +when using `make install`) 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) |