Modern ActivityPub compliant server https://epicyon.net

Bob Mottram 21b99f2d61 Session parameters not needed 1 minute ago
emoji 6a8c014cba Blob cat and meowmoji 1 week ago
img e8fdf37dd3 Extra screenshot 2 days ago
orgs e0c833dbba Comma 2 days ago
scripts 19703c0336 Change example install directory to /opt 13 hours ago
translations e08e12de1f Change password on edit profile screen 23 hours ago
website a1002c125d Link to configuration file 12 hours ago
LICENSE e5a03e0fe9 Initial 4 months ago
Makefile 323f9f8717 Organization structures 4 days ago
README.md 9188d6fdcb Caddy web server configuration 13 hours ago
README_commandline.md e78f453460 Indents 1 day ago
README_customizations.md 89f72579ca Document theme command 2 months ago
README_goals.md 18c9f0faf2 Link to goals 2 months ago
acceptreject.py fd8f696f2e Extra debug on follow accept 20 hours ago
announce.py 0192532293 Fixing non-ascii text 3 days ago
auth.py ad92d8ee08 Tidying 1 week ago
availability.py 0192532293 Fixing non-ascii text 3 days ago
blocking.py 0192532293 Fixing non-ascii text 3 days ago
blurhash.py 83b172d046 Functions for image attachments 4 months ago
cache.py 077d34ba7a Tidying the loading and saving of json 3 weeks ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 13 hours ago
capabilities.py 077d34ba7a Tidying the loading and saving of json 3 weeks ago
code-of-conduct.md 8efa97296b Mention casteism 3 days ago
config.py 077d34ba7a Tidying the loading and saving of json 3 weeks ago
content.py cae6637b24 Profile updates supporting utf-8 2 days ago
daemon.py 21b99f2d61 Session parameters not needed 1 minute ago
default_about.txt 91981c7953 About screen 2 months ago
default_tos.txt 8efa97296b Mention casteism 3 days ago
delete.py 0192532293 Fixing non-ascii text 3 days ago
donate.py d17b984bbb Move donation functions to their own module 5 days ago
epicyon-calendar.css 82df24d3ce Calendar day style 1 month ago
epicyon-follow.css 4b321074bb css variables 2 months ago
epicyon-login.css 0de94b58b9 Curved corners on login screen 3 weeks ago
epicyon-profile.css 81f187acf2 Donate button size on mobile 6 days ago
epicyon-suspended.css 4b321074bb css variables 2 months ago
epicyon.py 21b99f2d61 Session parameters not needed 1 minute ago
filters.py 779fc287d1 Version 1.0.0 2 months ago
follow.py 0192532293 Fixing non-ascii text 3 days ago
httpsig.py cd90434ce3 Variations on the theme 15 hours ago
inbox.py 21b99f2d61 Session parameters not needed 1 minute ago
like.py 0192532293 Fixing non-ascii text 3 days ago
manualapprove.py 667d0262ea Prepend to followers file 1 week ago
media.py a21b7fd958 Handle failure to open image 2 weeks ago
metadata.py c14ab97586 nodeinfo metadata endpoint 19 minutes ago
migrate.py 6bf78d35c4 Account migration functions 1 week ago
ocaps.md 12072b57e1 Separate ocaps document 3 months ago
person.py d17b984bbb Move donation functions to their own module 5 days ago
posts.py 21b99f2d61 Session parameters not needed 1 minute ago
roles.py 0192532293 Fixing non-ascii text 3 days ago
session.py 21b99f2d61 Session parameters not needed 1 minute ago
shares.py 0192532293 Fixing non-ascii text 3 days ago
skills.py 0192532293 Fixing non-ascii text 3 days ago
tests.py 21b99f2d61 Session parameters not needed 1 minute ago
theme 2921f58a9a Avoid issues with appending theme setting to config.json 13 hours ago
threads.py 49a1169e67 Longer thread timeout 5 days ago
utils.py 74a0b0b2c1 Get published time 6 days ago
webfinger.py c14ab97586 nodeinfo metadata endpoint 19 minutes ago
webinterface.py a4c43e44c3 Indent 23 hours 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

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 nginx
sudo pip3 install requests commentjson beautifulsoup4 pycryptodome

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

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