saulteafarmer/khatru-pyramid
1
0
Fork 0
mirror of https://github.com/github-tijlxyz/khatru-pyramid.git synced 2025-04-19 10:21:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
github-tijlxyz 2024-03-01 01:40:15 +01:00
parent 620a2a4105
commit c8e86b9f4c
No known key found for this signature in database
GPG Key ID: 2EB6AC84AFE26CD6
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,17 +1,31 @@
# Khatru Invite
# Khatru Pyramid
A relay based on [Khatru](https://github.com/fiatjaf/khatru) with a invite hierarchy feature.
### Deploy with docker
```
docker run \
$ docker run \
-p 3334:3334 \
-v ./users.json:/app/users.json \
-v ./db:/app/db \
-e DOMAIN=yourdomain.example.com \
-e DOMAIN="yourdomain.example.com" \
-e RELAY_NAME="your relay name" \
-e RELAY_PUBKEY="your nostr hex pubkey" \
tijlxyz/khatru-pyramid:latest
```
### Deploy with
- [YunoHost](https://github.com/YunoHost-Apps/khatru-pyramid_ynh) ([app catalog](https://apps.yunohost.org/catalog) [pending](https://github.com/YunoHost/apps/pull/2077))
- [Cloudron](https://github.com/github-tijlxyz/khatru-pyramid_cloudron) ([app catalog](https://www.cloudron.io/store/index.html) [pending](https://forum.cloudron.io/topic/11146/khatru-pyramid-a-nostr-relay))
### 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
```

2
go.mod
View File

@ -1,4 +1,4 @@
module github.com/github-tijlxyz/khatru-invite
module github.com/github-tijlxyz/khatru-pyramid
go 1.21.4