-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
620a2a4
commit c8e86b9
Showing
2 changed files
with
18 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
module github.com/github-tijlxyz/khatru-invite | ||
module github.com/github-tijlxyz/khatru-pyramid | ||
|
||
go 1.21.4 | ||
|
||
|