Go to file
Izalia Mae b8f30d98ec Merge pull request 'switch out sanic for custom server' (#1) from dev into main
Reviewed-on: #1
2021-10-26 06:06:47 -04:00
uncia add manage command: install 2021-10-26 06:05:36 -04:00
.gitignore finish up webui 2020-02-08 11:40:28 -05:00
LICENSE ability to accept follows 2021-09-14 07:33:32 -04:00
Makefile fix 'make reinstall' 2021-09-22 13:57:45 -04:00
README.md add rule editing 2021-09-15 09:13:25 -04:00
reload.json catch errors when sending messages 2021-09-17 13:40:46 -04:00
requirements.txt fix run_retries and add retry commands to manage 2021-10-25 11:40:28 -04:00

README.md

Uncia Relay

A light, but featureful, ActivityPub relay. Public posts pushed to the relay will be forwarded to every other subscribed instance.

Installation

Easy

make install

Manual

Create a virtual environment

python3 -m venv ~/.local/share/venv/uncia

Update pip and setuptools, install wheel to avoid compiling modules, and install dependencies

~/.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

Run the relay setup to configure it

~/.local/share/venv/uncia/bin/python -m uncia.manage setup

Running

You can run either make run or ~/.local/share/venv/uncia/bin/python -m uncia

Manage Commands

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.

~/.local/share/venv/uncia/bin/python -m uncia.manage <command> [*args]