installation.md 1.74 KB
Newer Older
Izalia Mae's avatar
Izalia Mae committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# 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/`


## 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

	pipx install git+https://git.pleroma.social/pleroma/relay@0.2.0

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

	activityrelay setup

Finally start it up with the run command.

	activityrelay run

Note: Pipx requires python 3.7+. If your distro doesn't have a compatible version of python, it can
be installed via 


## Pip

The instructions for installation via pip are very similar to pipx. Installation can be done from
git

	python3 -m pip install git+https://git.pleroma.social/pleroma/relay@0.2.0

or a cloned git repo.

	python3 -m pip install .

Now run the configuration wizard

	activityrelay setup

And start the relay when finished

	activityrelay run


## 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