2020-01-25 16:42:55 -05:00
# Uncia Relay
2020-01-11 02:04:59 -05:00
2021-09-14 07:33:32 -04:00
A light, but featureful, ActivityPub relay. Public posts pushed to the relay will be forwarded to every other subscribed instance.
2020-02-17 14:52:53 -05:00
## Installation
2021-09-14 07:33:32 -04:00
### Easy
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
make install
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
### Manual
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
Create a virtual environment
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
python3 -m venv ~/.local/share/venv/uncia
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
Update pip and setuptools, install wheel to avoid compiling modules, and install dependencies
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
~/.local/share/venv/uncia/bin/python -m pip install -U pip setuptools
~/.local/share/venv/uncia/bin/python -m pip install wheel
~/.local/share/venv/uncia/bin/python -m pip install -r requirements.txt
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
Run the relay setup to configure it
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
~/.local/share/venv/uncia/bin/python -m uncia.manage setup
2020-02-17 14:52:53 -05:00
2021-09-15 07:59:10 -04:00
## Running
2020-02-17 14:52:53 -05:00
2021-09-14 07:33:32 -04:00
You can run either `make run` or `~/.local/share/venv/uncia/bin/python -m uncia`
2021-09-15 07:59:10 -04:00
## Manage Commands
2021-09-15 09:13:25 -04:00
There are a number of commands that can be ran to manage various parts of the relay. Some require the relay to be running in order to work. Run the `help` command to list all of the available commands.
2021-09-15 07:59:10 -04:00
~/.local/share/venv/uncia/bin/python -m uncia.manage < command > [*args]
