2022-05-06 07:04:51 +00:00
|
|
|
# Installation
|
|
|
|
|
|
|
|
|
|
There are a few ways to install ActivityRelay. Follow one of the methods below, setup a reverse
|
|
|
|
|
proxy, and setup the relay to run via a supervisor. Example configs for caddy, nginx, and systemd
|
|
|
|
|
in `installation/`
|
|
|
|
|
|
|
|
|
|
|
2022-12-20 13:00:18 +00:00
|
|
|
## Pre-build Executables
|
|
|
|
|
|
|
|
|
|
All in one executables can be downloaded from `https://git.pleroma.social/pleroma/relay/-/releases`
|
|
|
|
|
under the `Other` section of `Assets`. They don't require any extra setup and can be placed
|
|
|
|
|
anywhere. Run the setup wizard
|
|
|
|
|
|
|
|
|
|
./activityrelay setup
|
|
|
|
|
|
|
|
|
|
and start it up when done
|
|
|
|
|
|
|
|
|
|
./activityrelay run
|
|
|
|
|
|
|
|
|
|
|
2022-05-06 07:04:51 +00:00
|
|
|
## Pipx
|
|
|
|
|
|
|
|
|
|
Pipx uses pip and a custom venv implementation to automatically install modules into a Python
|
|
|
|
|
environment and is the recommended method. Install pipx if it isn't installed already. Check out
|
|
|
|
|
the [official pipx docs](https://pypa.github.io/pipx/installation/) for more in-depth instructions.
|
|
|
|
|
|
|
|
|
|
python3 -m pip install pipx
|
|
|
|
|
|
|
|
|
|
Now simply install ActivityRelay directly from git
|
|
|
|
|
|
2022-12-08 09:17:17 +00:00
|
|
|
pipx install git+https://git.pleroma.social/pleroma/relay@0.2.4
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
Or from a cloned git repo.
|
|
|
|
|
|
|
|
|
|
pipx install .
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
2022-05-06 21:23:44 +00:00
|
|
|
~/.local/bin/activityrelay setup
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
Finally start it up with the run command.
|
|
|
|
|
|
2022-05-06 21:23:44 +00:00
|
|
|
~/.local/bin/activityrelay run
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
Note: Pipx requires python 3.7+. If your distro doesn't have a compatible version of python, it can
|
2022-05-06 21:23:44 +00:00
|
|
|
be installed via [pyenv](https://github.com/pyenv/pyenv).
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Pip
|
|
|
|
|
|
|
|
|
|
The instructions for installation via pip are very similar to pipx. Installation can be done from
|
|
|
|
|
git
|
|
|
|
|
|
2022-12-08 09:17:17 +00:00
|
|
|
python3 -m pip install git+https://git.pleroma.social/pleroma/relay@0.2.4
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
or a cloned git repo.
|
|
|
|
|
|
|
|
|
|
python3 -m pip install .
|
|
|
|
|
|
|
|
|
|
Now run the configuration wizard
|
|
|
|
|
|
2022-05-06 21:23:44 +00:00
|
|
|
python3 -m relay setup
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
And start the relay when finished
|
|
|
|
|
|
2022-05-06 21:23:44 +00:00
|
|
|
python3 -m relay run
|
2022-05-06 07:04:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Docker
|
|
|
|
|
|
|
|
|
|
Installation and management via Docker can be handled with the `docker.sh` script. To install
|
|
|
|
|
ActivityRelay, run the install command. Once the image is built and the container is created,
|
|
|
|
|
your will be asked to fill out some config options for your relay.
|
|
|
|
|
|
|
|
|
|
./docker.sh install
|
|
|
|
|
|
|
|
|
|
Finally start it up. It will be listening on TCP port 8080.
|
|
|
|
|
|
|
|
|
|
./docker.sh start
|
