saulteafarmer/khatru-pyramid
1
0
Fork 0
mirror of https://github.com/github-tijlxyz/khatru-pyramid.git synced 2025-06-06 01:02:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
tijl 2024-03-22 15:52:24 +01:00
parent de6d6a735e
commit 7c32755cf5
No known key found for this signature in database
GPG Key ID: 2EB6AC84AFE26CD6
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,8 +4,8 @@ A relay based on [Khatru](https://github.com/fiatjaf/khatru) with a invite hiera
### Deploy with docker ### Deploy with docker
``` ```sh
$ docker run \ docker run \
-p 3334:3334 \ -p 3334:3334 \
-v ./users.json:/app/users.json \ -v ./users.json:/app/users.json \
-v ./db:/app/db \ -v ./db:/app/db \
@ -22,17 +22,19 @@ $ docker run \
### Manually build ### Manually build
``` ```sh
$ git clone https://github.com/github-tijlxyz/khatru-pyramid git clone https://github.com/github-tijlxyz/khatru-pyramid && cd khatru-pyramid
$ cd khatru-pyramid just build
$ go build # or run DOMAIN="example.com" RELAY_NAME="my relay" RELAY_PUBKEY=yourpubkey ./khatru-pyramid
$ DOMAIN=example.com RELAY_NAME=test RELAY_PUBKEY=yourpubkey ./khatru-pyramid
``` ```
### Configuration ### Configuration
Format `users.json` as follows: Look at [example.env](./example.env) for all configuration options.
You can also manually edit the `users.json` file. Do this only when the server is down.
`users.json` is formatted as follows:
```json ```json
{ "[user_pubkey_hex]": "[invited_by_pubkey_hex]" } { "[user_pubkey_hex]": "[invited_by_pubkey_hex]" }
``` ```