Modern ActivityPub compliant server https://epicyon.net

Bob Mottram 6ea855feef Follow test without capabilities 15 hours ago
emoji 5230de3d38 Calendar icon 5 days ago
img 884d30308e Screenshot size 2 days ago
scripts 133094acdb Better clean 1 week ago
translations aaa60e2763 Calendar screen 5 days ago
website 95a9e90794 Describe calendar 2 days ago
LICENSE e5a03e0fe9 Initial 3 months ago
Makefile 133094acdb Better clean 1 week ago
README.md 160f272b5d Matrix 2 weeks ago
README_commandline.md 12873db070 Update readme for groups 1 week ago
README_customizations.md 89f72579ca Document theme command 1 month ago
README_goals.md 18c9f0faf2 Link to goals 1 month ago
acceptreject.py cd5af800c2 Allow profile in path 1 month ago
announce.py 48c5424e33 More retries 3 days ago
auth.py cd5af800c2 Allow profile in path 1 month ago
availability.py 48c5424e33 More retries 3 days ago
blocking.py 28d30ed497 Check for blocked domains being announced 1 month ago
blurhash.py 83b172d046 Functions for image attachments 3 months ago
cache.py 48c5424e33 More retries 3 days ago
capabilities.py 48c5424e33 More retries 3 days ago
code-of-conduct.md eea0aa85ab Link to chat room 2 weeks ago
config.py 48c5424e33 More retries 3 days ago
content.py 714f34609d Tidying 3 days ago
daemon.py dac79d53f9 Extra exceptions 1 day ago
default_about.txt 91981c7953 About screen 1 month ago
default_tos.txt d69449098d Block monopolies 1 month ago
delete.py cd5af800c2 Allow profile in path 1 month ago
epicyon-calendar.css 82df24d3ce Calendar day style 4 days ago
epicyon-follow.css 4b321074bb css variables 1 month ago
epicyon-login.css a10645d871 Larger license link on login screen 1 week ago
epicyon-profile.css 884f897285 More even font size on mobile 15 hours ago
epicyon-suspended.css 4b321074bb css variables 1 month ago
epicyon.py 43cdb1e4be Command to remove groups 1 week ago
filters.py 779fc287d1 Version 1.0.0 1 month ago
follow.py dfa183a69b Missing debug 15 hours ago
httpsig.py 779fc287d1 Version 1.0.0 1 month ago
inbox.py 1f0a869fbe Extra checks when removing inbox queue items 2 days ago
like.py 48c5424e33 More retries 3 days ago
manualapprove.py dfa183a69b Missing debug 15 hours ago
media.py 5a7180e040 media type 1 month ago
ocaps.md 12072b57e1 Separate ocaps document 2 months ago
person.py 48c5424e33 More retries 3 days ago
posts.py 85415f579f Exception handling in threaded post 1 day ago
roles.py 48c5424e33 More retries 3 days ago
session.py 47225c686b Storing avatars in cache 1 month ago
shares.py 48c5424e33 More retries 3 days ago
skills.py 48c5424e33 More retries 3 days ago
tests.py 6ea855feef Follow test without capabilities 15 hours ago
theme 91073aca1b high visibility theme 1 day ago
threads.py cb0f95c62b Exceptions on threads 1 day ago
utils.py b0be557047 Fix status number using sequence data 3 days ago
webfinger.py 48c5424e33 More retries 3 days ago
webinterface.py 27ec9a8700 Link back to calendar 3 days ago

README.md

Epicyon, meaning "more than a dog". Largest of the Borophaginae which lived in North America 20-5 million years ago.

Epicyon is a modern ActivityPub compliant server implementing both S2S and C2S protocols and sutable for installation on single board computers. It includes features such as moderation tools, post expiry, content warnings, image descriptions and perimeter defense against adversaries.

Project Goals - Commandline interface - Customizations - Object Capabilities - Code of Conduct

Matrix room: #epicyon:matrix.freedombone.net

Includes emojis designed by OpenMoji – the open-source emoji and icon project. License: CC BY-SA 4.0. Follow request icon from flaticon.

Package Dependencies

On Arch/Parabola:

sudo pacman -S tor python-pip python-pysocks python-pycryptodome \
               python-beautifulsoup4 imagemagick python-pillow \
	       python-numpy python-dateutil certbot
sudo pip install commentjson

Or on Debian:

sudo apt-get -y install tor python3-pip python3-socks imagemagick \
                python3-numpy python3-setuptools python3-crypto \
		python3-dateutil python3-pil.imagetk certbot
sudo pip3 install commentjson beautifulsoup4 pycryptodome

Installation

In the most common case you'll be using systemd to set up a daemon to run the server.

Add a dedicated user so that we don't have to run as root.

adduser --system --home=/etc/epicyon --group epicyon

Edit /etc/systemd/system/epicyon.service and add the following:

[Unit]
Description=epicyon
After=syslog.target
After=network.target

[Service]
Type=simple
User=epicyon
Group=epicyon
WorkingDirectory=/etc/epicyon
ExecStart=/usr/bin/python3 /etc/epicyon/epicyon.py --port 443 --proxy 7156 --domain YOUR_DOMAIN --registration open --debug
Environment=USER=epicyon
Restart=always
StandardError=syslog

[Install]
WantedBy=multi-user.target

Here the server was installed to /etc/epicyon, but you can change that to wherever you installed it.

Then run the daemon:

systemctl enable epicyon
chown -R epicyon:epicyon /etc/epicyon
systemctl start epicyon

Check the status of the daemon with:

systemctl status epicyon

If it's not running then you can also look at the log:

journalctl -u epicyon

You'll also need to set up a web server configuration. For Nginx edit /etc/nginx/sites-available/YOUR_DOMAIN as follows:

server {
    listen 80;
    listen [::]:80;
    server_name YOUR_DOMAIN;
    root /var/www/YOUR_DOMAIN/htdocs;
    access_log /dev/null;
    error_log /dev/null;
    client_max_body_size 31m;
    client_body_buffer_size 128k;

    limit_conn conn_limit_per_ip 10;
    limit_req zone=req_limit_per_ip burst=10 nodelay;

    index index.html;
    rewrite ^ https://$server_name$request_uri? permanent;
}

server {
    listen 443 ssl;
    server_name YOUR_DOMAIN;

    ssl_stapling off;
    ssl_stapling_verify off;
    ssl on;
    ssl_certificate /etc/letsencrypt/live/YOUR_DOMAIN/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/YOUR_DOMAIN/privkey.pem;
    #ssl_dhparam /etc/ssl/certs/YOUR_DOMAIN.dhparam;

    ssl_session_cache  builtin:1000  shared:SSL:10m;
    ssl_session_timeout 60m;
    ssl_prefer_server_ciphers on;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS';
    add_header X-Frame-Options DENY;
    add_header X-Content-Type-Options nosniff;
    add_header X-XSS-Protection "1; mode=block";
    add_header X-Download-Options noopen;
    add_header X-Permitted-Cross-Domain-Policies none;

    add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";
    add_header Strict-Transport-Security max-age=15768000;

    access_log /dev/null;
    error_log /dev/null;

    root /var/www/YOUR_DOMAIN/htdocs;
    index index.html;
 
    location / {
        proxy_http_version 1.1;
        client_max_body_size 31M;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forward-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forward-Proto http;
        proxy_set_header X-Nginx-Proxy true;
        proxy_temp_file_write_size 64k;
        proxy_connect_timeout 10080s;
        proxy_send_timeout 10080;
        proxy_read_timeout 10080;
        proxy_buffer_size 64k;
        proxy_buffers 16 32k;
        proxy_busy_buffers_size 64k;
        proxy_redirect off;
        proxy_request_buffering off;
        proxy_buffering off;
        proxy_pass http://localhost:7156;
    }
}

Changing your domain name as appropriate. Activate the configuration with:

ln -s /etc/nginx/sites-available/YOUR_DOMAIN /etc/nginx/sites-enabled/

Generate a LetsEncrypt certificate.

certbot certonly -n --server https://acme-v01.api.letsencrypt.org/directory --standalone -d YOUR_DOMAIN --renew-by-default --agree-tos --email YOUR_EMAIL

And restart the web server:

systemctl restart nginx

Running Unit Tests

To run the unit tests:

python3 epicyon.py --tests

To run the network tests. These simulate instances exchanging messages.

python3 epicyon.py --testsnetwork