From 1c3b1b39e657e62333636a2eecd2068d9d359212 Mon Sep 17 00:00:00 2001 From: Izalia Mae Date: Fri, 6 May 2022 17:23:44 -0400 Subject: [PATCH] docs: don't assume activityrelay is in PATH --- docs/commands.md | 4 ++++ docs/configuration.md | 2 +- docs/installation.md | 10 +++++----- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/commands.md b/docs/commands.md index a92e784..6e7da54 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -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 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 diff --git a/docs/configuration.md b/docs/configuration.md index b76b931..ecadac3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -75,7 +75,7 @@ the block list, it will be removed from the inbox list on startup. ### Blocked Software 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: - activityrelay diff --git a/docs/installation.md b/docs/installation.md index 7445f58..2e93904 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 out config options for your relay - activityrelay setup + ~/.local/bin/activityrelay setup 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 -be installed via +be installed via [pyenv](https://github.com/pyenv/pyenv). ## Pip @@ -47,11 +47,11 @@ or a cloned git repo. Now run the configuration wizard - activityrelay setup + python3 -m relay setup And start the relay when finished - activityrelay run + python3 -m relay run ## Docker