nik/chorus
1
0
Fork 0
mirror of https://github.com/mikedilger/chorus.git synced 2026-01-03 06:15:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
Mike Dilger 2024-07-13 15:27:01 +12:00
parent 4dbcbc04c3
commit 4d64a45a38
3 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -4,7 +4,7 @@ Chorus is a nostr relay.
It is pretty fast: [docs/PERFORMANCE.md](docs/PERFORMANCE.md).
It can work as your personal relay: [docs/PERSONAL_RELAY.md](docs/PERSONAL_RELAY.md).
It can work as your personal relay (or as an open relay): [docs/PERSONAL_RELAY.md](docs/PERSONAL_RELAY.md)
To deploy chorus, read [docs/DEPLOYING.md](docs/DEPLOYING.md)
@ -14,6 +14,8 @@ To undertand the relay's behavior, read [docs/BEHAVIOR.md](docs/BEHAVIOR.md)
To understand command line tools, read [docs/TOOLS.md](docs/TOOLS.md)
To understand the management API, read [docs/MANAGEMENT.md](docs/MANAGEMENT.md)
Chorus does not have any provisions for charging users.
Chorus does not have any provisions for synchronizing events with other relays outside of the nostr protocol.

23
docs/MANAGEMENT.md Normal file
View File

@ -0,0 +1,23 @@
# Chorus Management
This page is about using the online Management API.
You can also do management and moderation via command line [TOOLS.md](TOOLS.md).
## Relay Management NIP
The Relay Management API is in flux currently. It is still a pull request on the NIPs repo: [PR 1325](https://github.com/nostr-protocol/nips/pull/1325).
This document may go out of date as things are changing rapidly.
## The status of a pubkey
Users can be in one of four states: Authorized, Approved, Banned, and Default.
**Authorized**: These are the users you configured in your chorus.toml file, the users that the chorus was setup to serve, or the paying users (if you sell service). These user's events are always accepted and these users can read everything (except other user's DMs for example). These users are statically configured in the config file and cannot be changed dynamically.
**Approved**: These are users who are not authorized, but which via moderation have been approved. Approved user's posts are publically available to anybody to read. Because they are not authorized, they can only post replies to authorized users.
**Banned**: These are users who cannot make any posts at all to the relay.
**Default**: All pubkeys not explicitly put into any of the other three categories default to this category. Because they are not authorized, they can only post replies to authorized users. Because they are not approved, these replies are only visible to authorized users and are not publicly visible (unless and until a moderator approves the specific post).

8
docs/PERSONAL_RELAY.md
View File

@ -5,14 +5,14 @@ users, perhaps just yourself.
It hosts your own events and makes them available to the public.
It accepts events that tag your users, but doesn't allow the public to read them back. Only
your users (after being authenticated) can see them.
It accepts events that tag your users, but doesn't allow the public to read them back until
they have passed moderation and until then, only your users (after being authenticated) can see
them.
One nice thing about a personal relay is that you are in control, and you have a record
of your events in your possession.
Another nice thing is that you don't have to moderate content, since the only content
that is served to the public is content that your trusted users created.
Another nice thing is that you don't have to moderate content if you don't care to.
## The Dark Side