docs: don't assume activityrelay is in PATH

This commit is contained in:
Izalia Mae 2022-05-06 17:23:44 -04:00
parent c24a0ce6d5
commit 1c3b1b39e6
3 changed files with 10 additions and 6 deletions

View file

@ -5,6 +5,10 @@ any category or command to get help on that specific option (ex. `activityrelay
Note: Unless specified, it is recommended to run any commands while the relay is shutdown. Note: Unless specified, it is recommended to run any commands while the relay is shutdown.
Note 2: `activityrelay` is only available via pip or pipx if `~/.local/bin` is in `$PATH`. If it
isn't, use `python3 -m relay` if installed via pip or `~/.local/bin/activityrelay` if installed
via pipx
## Run ## Run

View file

@ -75,7 +75,7 @@ the block list, it will be removed from the inbox list on startup.
### Blocked Software ### Blocked Software
A list of ActivityPub software which cannot follow your relay. This list is empty by default, but A list of ActivityPub software which cannot follow your relay. This list is empty by default, but
setting this to the above list will block all other relays and prevent relay chains setting this to the below list will block all other relays and prevent relay chains
blocked_software: blocked_software:
- activityrelay - activityrelay

View file

@ -24,14 +24,14 @@ Or from a cloned git repo.
Once finished, you can set up the relay via the setup command. It will ask a few questions to fill Once finished, you can set up the relay via the setup command. It will ask a few questions to fill
out config options for your relay out config options for your relay
activityrelay setup ~/.local/bin/activityrelay setup
Finally start it up with the run command. Finally start it up with the run command.
activityrelay run ~/.local/bin/activityrelay run
Note: Pipx requires python 3.7+. If your distro doesn't have a compatible version of python, it can Note: Pipx requires python 3.7+. If your distro doesn't have a compatible version of python, it can
be installed via be installed via [pyenv](https://github.com/pyenv/pyenv).
## Pip ## Pip
@ -47,11 +47,11 @@ or a cloned git repo.
Now run the configuration wizard Now run the configuration wizard
activityrelay setup python3 -m relay setup
And start the relay when finished And start the relay when finished
activityrelay run python3 -m relay run
## Docker ## Docker