Go to file
2021-09-15 08:24:36 -04:00
uncia update help command 2021-09-15 08:24: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 finish basic relay functions 2021-09-15 07:27:18 -04:00
README.md update help command 2021-09-15 08:24:36 -04:00
reload.json ability to accept follows 2021-09-14 07:33:32 -04:00
requirements.txt ability to accept follows 2021-09-14 07:33:32 -04:00

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.

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

Command List

get current settings

config

change a setting

set <key> [value]

list current requests

request

accept a request (relay has to be running)

accept <actor, inbox, or domain>

reject a request (relay has to be running)

reject <actor, inbox, or domain>

list all subscribed instances

list

add an instance to the database (relay has to be running)

add <actor or domain>

remove an instance from the database

remove <actor, inbox, or domain>