Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
github-tijlxyz committed Mar 22, 2024
1 parent de6d6a7 commit 777bf61
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ A relay based on [Khatru](https://github.com/fiatjaf/khatru) with a invite hiera

### Deploy with docker

```
$ docker run \
```sh
docker run \
-p 3334:3334 \
-v ./users.json:/app/users.json \
-v ./db:/app/db \
Expand All @@ -22,17 +22,19 @@ $ docker run \

### Manually build

```
$ git clone https://github.com/github-tijlxyz/khatru-pyramid
$ cd khatru-pyramid
$ go build # or run
$ DOMAIN=example.com RELAY_NAME=test RELAY_PUBKEY=yourpubkey ./khatru-pyramid
```sh
git clone https://github.com/github-tijlxyz/khatru-pyramid && cd khatru-pyramid
just build
DOMAIN="example.com" RELAY_NAME="my relay" RELAY_PUBKEY=yourpubkey ./khatru-pyramid
```

### 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. In most cases this is not a good idea. Do this only when the server is fully down.
`users.json` is formatted as follows:
```json
{ "[user_pubkey_hex]": "[invited_by_pubkey_hex]" }
```

0 comments on commit 777bf61

Please sign in to comment.