Modern ActivityPub compliant server https://epicyon.net

Bob Mottram 9c0664692a Tox test 22 hours ago
emoji 322ba251f4 planet emoji 1 month ago
img f941d2541c Edit icon 4 weeks ago
orgs e0c833dbba Comma 4 months ago
scripts 302bda9aa1 Change GET benchmarks 4 months ago
translations 0ee0d432f6 Translations for blog description 4 weeks ago
website f6869f9308 Use debian cryptodome package 3 weeks ago
.gitlab-ci.yml 74a4cb90c5 Add gitlab CI 1 week ago
CONTRIBUTING.md 06ef125e89 Contributing file 4 months ago
CONTRIBUTORS.md 8463a118ef Add contributors list 1 week ago
Dockerfile 4bf127d93a Add dockerfile 4 months ago
LICENSE e5a03e0fe9 Initial 9 months ago
Makefile 839b4b7b5b Add a focal point to images 2 weeks ago
README.md f6869f9308 Use debian cryptodome package 3 weeks 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 23bb250deb Remove trailing whitespace 1 week ago
announce.py 23bb250deb Remove trailing whitespace 1 week ago
auth.py 23bb250deb Remove trailing whitespace 1 week ago
availability.py 23bb250deb Remove trailing whitespace 1 week ago
blocking.py 36267ac5f4 Faster checking for blocked domains 1 day ago
blog.py 23bb250deb Remove trailing whitespace 1 week ago
blurhash.py 23bb250deb Remove trailing whitespace 1 week ago
bookmarks.py 23bb250deb Remove trailing whitespace 1 week ago
cache.py 23bb250deb Remove trailing whitespace 1 week ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 4 months ago
capabilities.py 23bb250deb Remove trailing whitespace 1 week ago
code-of-conduct.md 8efa97296b Mention casteism 4 months ago
config.py d0884fa04d Tidying 1 week ago
content.py f9e8c09826 Decrease line lengths 23 hours ago
daemon.py 2047e86684 Reduce line lengths 23 hours ago
default_about.txt 91981c7953 About screen 7 months ago
default_tos.txt 9b66d96a89 from 2 months ago
delete.py 23bb250deb Remove trailing whitespace 1 week ago
donate.py 23bb250deb Remove trailing whitespace 1 week 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 23bb250deb Remove trailing whitespace 1 week ago
filters.py 23bb250deb Remove trailing whitespace 1 week ago
follow.py 23bb250deb Remove trailing whitespace 1 week ago
happening.py 23bb250deb Remove trailing whitespace 1 week ago
httpsig.py 23bb250deb Remove trailing whitespace 1 week ago
inbox.py 2f46c2b31f Minimum per minute quotas 1 day ago
like.py 9b5743159b object 2 days ago
manualapprove.py 23bb250deb Remove trailing whitespace 1 week ago
matrix.py d0884fa04d Tidying 1 week ago
media.py 23bb250deb Remove trailing whitespace 1 week ago
metadata.py 23bb250deb Remove trailing whitespace 1 week ago
migrate.py d0884fa04d Tidying 1 week ago
ocaps.md 12072b57e1 Separate ocaps document 8 months ago
outbox.py 23bb250deb Remove trailing whitespace 1 week ago
person.py 23bb250deb Remove trailing whitespace 1 week ago
pgp.py d0884fa04d Tidying 1 week ago
posts.py 23bb250deb Remove trailing whitespace 1 week ago
question.py 23bb250deb Remove trailing whitespace 1 week ago
roles.py 23bb250deb Remove trailing whitespace 1 week ago
schedule.py 23bb250deb Remove trailing whitespace 1 week ago
session.py 23bb250deb Remove trailing whitespace 1 week ago
shares.py 23bb250deb Remove trailing whitespace 1 week ago
skills.py 23bb250deb Remove trailing whitespace 1 week ago
ssb.py d0884fa04d Tidying 1 week ago
tests.py 9c0664692a Tox test 22 hours ago
theme.py 23bb250deb Remove trailing whitespace 1 week ago
threads.py 23bb250deb Remove trailing whitespace 1 week ago
tox.py d0884fa04d Tidying 1 week ago
utils.py 36267ac5f4 Faster checking for blocked domains 1 day ago
webfinger.py 23bb250deb Remove trailing whitespace 1 week ago
webinterface.py 233ae8e1ca Relative published link 1 day ago
xmpp.py d0884fa04d Tidying 1 week 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

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 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 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