Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
R
relay
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Pleroma
relay
Commits
be2c5b14
Commit
be2c5b14
authored
1 year ago
by
Izalia Mae
Browse files
Options
Downloads
Patches
Plain Diff
update docs
parent
38ea8b39
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/commands.md
+52
-7
52 additions, 7 deletions
docs/commands.md
docs/configuration.md
+3
-4
3 additions, 4 deletions
docs/configuration.md
with
55 additions
and
11 deletions
docs/commands.md
+
52
−
7
View file @
be2c5b14
...
...
@@ -9,7 +9,7 @@ use `python3 -m relay` if installed via pip or `~/.local/bin/activityrelay` if i
## Run
Run the relay.
Run the relay.
Optionally add
`-d`
or
`--dev`
to enable auto-reloading on code changes.
activityrelay run
...
...
@@ -58,6 +58,50 @@ Set a value for a config option
activityrelay config set <key> <value>
## User
### List
List all available users.
activityrelay user list
### Create
Create a new user. You will be prompted for the new password.
activityrelay user create <username> [associated ActivityPub handle]
### Delete
Delete a user.
activityrelay user delete <username>
### List Tokens
List all API tokens for a user.
activityrelay user list-tokens <username>
### Create Token
Generate a new API token for a user.
activityrelay user create-token <username>
### Delete Token
Delete an API token.
activityrelay user delete-token <code>
## Inbox
Manage the list of subscribed instances.
...
...
@@ -75,7 +119,7 @@ List the currently subscribed instances or relays.
Add an inbox to the database. If a domain is specified, it will default to
`https://{domain}/inbox`
.
If the added instance is not following the relay, expect errors when pushing messages.
activityrelay inbox add <inbox or domain>
activityrelay inbox add <inbox or domain>
--actor <actor url> --followid <follow activity ID> --software <nodeinfo software name>
### Remove
...
...
@@ -155,7 +199,7 @@ List the currently banned instances.
Add an instance to the ban list. If the instance is currently subscribed, it will be removed from
the inbox list.
activityrelay instance ban <domain>
activityrelay instance ban <domain>
--reason <text> --note <text>
### Unban
...
...
@@ -167,9 +211,10 @@ Remove an instance from the ban list.
### Update
Update the ban reason or note for an instance ban.
Update the ban reason or note for an instance ban. Either
`--reason`
and/or
`--note`
must be
specified.
activityrelay instance update bad.example.com --reason
"the baddest reason"
activityrelay instance update bad.example.com --reason
<text> --note <text>
## Software
...
...
@@ -194,7 +239,7 @@ name via nodeinfo.
If the name is
`RELAYS`
(case-sensitive), add all known relay software names to the list.
activityrelay software ban [-f/--fetch-nodeinfo] <name, domain, or RELAYS>
activityrelay software ban [-f/--fetch-nodeinfo] <name, domain, or RELAYS>
--reason <text> --note <text>
### Unban
...
...
@@ -214,4 +259,4 @@ If the name is `RELAYS` (case-sensitive), remove all known relay software names
Update the ban reason or note for a software ban. Either
`--reason`
and/or
`--note`
must be
specified.
activityrelay software update relay.example.com --reason
"begone relay"
activityrelay software update relay.example.com --reason
<text> --note <text>
This diff is collapsed.
Click to expand it.
docs/configuration.md
+
3
−
4
View file @
be2c5b14
...
...
@@ -19,11 +19,10 @@ proxy is on the same host.
port: 8080
###
Push
Workers
###
Web
Workers
The relay can be configured to use threads to push messages out. For smaller relays, this isn't
necessary, but bigger ones (>100 instances) will want to set this to the number of available cpu
threads.
The number of processes to spawn for handling web requests. Leave it at 0 to automatically detect
how many processes should be spawned.
workers: 0
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment