Modern ActivityPub compliant server https://epicyon.net

Bob Mottram 51db9230ae Static analysis on all source files 2 days ago
emoji 322ba251f4 planet emoji 1 month ago
img acc1361c4d Quirky 1 week ago
orgs e0c833dbba Comma 4 months ago
scripts 302bda9aa1 Change GET benchmarks 4 months ago
translations 0ee0d432f6 Translations for blog description 1 month ago
website bbd4911135 Update readme 2 days ago
.gitlab-ci.yml 74a4cb90c5 Add gitlab CI 2 weeks ago
CONTRIBUTING.md 06ef125e89 Contributing file 4 months ago
CONTRIBUTORS.md 8463a118ef Add contributors list 2 weeks ago
Dockerfile 4bf127d93a Add dockerfile 4 months ago
LICENSE e5a03e0fe9 Initial 9 months ago
Makefile 839b4b7b5b Add a focal point to images 4 weeks ago
README.md 1bd07ed1ca Document static analysis 2 days ago
README_commandline.md e78f453460 Indents 4 months ago
README_customizations.md 9561f2a557 Update documentation for themes 4 months ago
README_goals.md 18c9f0faf2 Link to goals 7 months ago
acceptreject.py ae5b9f579f flake8 style 6 days ago
announce.py 65d3ace372 flake8 style 6 days ago
auth.py 805aef6a74 flake8 style 6 days ago
availability.py 2c6169fa64 flake8 style 6 days ago
blocking.py 14433d8534 flake8 format 2 days ago
blog.py 14433d8534 flake8 format 2 days ago
blurhash.py 51db9230ae Static analysis on all source files 2 days ago
bookmarks.py fa7c457150 flake8 style 6 days ago
cache.py 161cef7fff flake8 style 5 days ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 4 months ago
capabilities.py ba493f9e20 flake8 format 2 days ago
code-of-conduct.md 8efa97296b Mention casteism 5 months ago
config.py a70793b616 flake8 style 5 days ago
content.py dbcfbd1a8c flake8 style 5 days ago
daemon.py 2f8d97701a flake8 format for daemon 5 days ago
default_about.txt 91981c7953 About screen 7 months ago
default_tos.txt 9b66d96a89 from 2 months ago
delete.py dfb1263f1a flake8 format 4 days ago
donate.py 9b713efb86 flake8 format 4 days ago
epicyon-calendar.css 1634f3b5ba Icon style 1 month ago
epicyon-follow.css 0a6d411360 Font size 1 month ago
epicyon-login.css 0de94b58b9 Curved corners on login screen 5 months ago
epicyon-profile.css eda4cae521 rss icon at end of page 1 month ago
epicyon-suspended.css 4b321074bb css variables 6 months ago
epicyon.py 654c5104d5 flake8 format 4 days ago
filters.py a9ee0fc1b2 flake8 format 4 days ago
follow.py 283a4d54c1 flake8 format 4 days ago
happening.py 34abcb54c2 flake8 format 4 days ago
httpsig.py 844f898b94 flake8 format 4 days ago
inbox.py 6b092d63ec flake8 format 4 days ago
like.py 128e431e9f flake8 format 4 days ago
manualapprove.py a85baf08ed flake8 format 4 days ago
matrix.py e2e2db91d4 flake8 format 4 days ago
media.py 840e726753 flake8 format 4 days ago
metadata.py 295814cd9b flake8 format 4 days ago
migrate.py 08a1b05a76 flake8 format 4 days ago
ocaps.md 12072b57e1 Separate ocaps document 8 months ago
outbox.py 2bbfd60969 flake8 format 4 days ago
person.py 7d47d27dec flake8 format 4 days ago
pgp.py 97b0338441 flake8 format 4 days ago
posts.py da3900c9f1 Don't return 3 days ago
question.py 3334cc0466 flake8 format 3 days ago
roles.py d55fe8bb59 flake8 format 3 days ago
schedule.py bfe37d5ae7 flake8 format 3 days ago
session.py d652485f8a flake8 format 3 days ago
shares.py b7fc2b948d flake8 format 3 days ago
skills.py 05d2d3d983 flake8 format 3 days ago
ssb.py a0930a61b8 flake8 format 3 days ago
static_analysis 51db9230ae Static analysis on all source files 2 days ago
tests.py a8a0465c01 flake8 format for unit tests 2 days ago
theme.py 02ce4e3d14 flake8 format 3 days ago
threads.py ad2c26eebf flake8 format 3 days ago
tox.py 6d19fa47a1 flake8 format 3 days ago
utils.py b63bf2c72d flake8 format 3 days ago
webfinger.py dc2386c583 flake8 format 3 days ago
webinterface.py cda11dae36 Indentation 2 days ago
xmpp.py bb12ce191e flake8 format 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. Blob Cat Emoji and Meowmoji were made by Nitro Blob Hub, licensed under Apache 2.0.

Package Dependencies

You will need python version 3.7 or later.

On Arch/Parabola:

sudo pacman -S tor python-pip python-pysocks python-pycryptodome \
               imagemagick python-pillow python-requests \
	       perl-image-exiftool python-numpy python-dateutil \
	       certbot flake8

Or on Debian:

sudo apt install -y \
    tor python3-socks imagemagick \
    python3-numpy python3-setuptools \
    python3-crypto python3-cryptodome \
    python3-dateutil python3-pil.imagetk
    python3-idna python3-requests \
    libimage-exiftool-perl python3-flake8 \
    certbot nginx

Installation

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

The following instructions install Epicyon to the /etc directory. It's not essential that it be installed there, and it could be in any other preferred directory.

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

adduser --system --home=/opt/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=/opt/epicyon
ExecStart=/usr/bin/python3 /opt/epicyon/epicyon.py --port 443 --proxy 7156 --domain YOUR_DOMAIN --registration open
Environment=USER=epicyon
Environment=PYTHONUNBUFFERED=true
Restart=always
StandardError=syslog

[Install]
WantedBy=multi-user.target

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

Then run the daemon:

systemctl enable epicyon
chown -R epicyon:epicyon /opt/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;
    access_log /dev/null;
    error_log /dev/null;
    client_max_body_size 31m;
    client_body_buffer_size 128k;

    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;

    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 on;
        proxy_buffering on;
        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

If you are using the Caddy web server then see caddy.example.conf

Running Static Analysis

Static analysis can be run with:

./static_analysis

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