Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar and sharing economy features to empower your federated community.

Bob Mottram ac0dd52c78 Check for repeated like notifications 1 day ago
deploy 6fbba92427 Security audit script 1 day ago
emoji 21d41675fa Extra emoji 6 days ago
fonts 6e46e28986 Extra font 1 week ago
gemini 6fbba92427 Security audit script 1 day ago
img 30f4fbbdb6 Eyes banner 4 days ago
orgs e0c833dbba Comma 8 months ago
scripts ba38e6c995 Log http server errors 1 month ago
translations c34aa81962 PGP fingerprint in profile 4 days ago
website 6fbba92427 Security audit script 1 day ago
.datignore bd06a914d4 Ignore file for dat 1 month ago
.gitlab-ci.yml 74a4cb90c5 Add gitlab CI 3 months ago
CONTRIBUTING.md 06ef125e89 Contributing file 7 months ago
CONTRIBUTORS.md 8463a118ef Add contributors list 3 months ago
Dockerfile d5b7dd97af Extra debian dependency 2 weeks ago
LICENSE e5a03e0fe9 Initial 1 year ago
Makefile 0de149799f Clear dot files 1 day ago
README.md 6fbba92427 Security audit script 1 day ago
README_commandline.md 7b06a3b262 Plotting federated instances 1 day ago
README_customizations.md 9561f2a557 Update documentation for themes 7 months ago
README_goals.md 18c9f0faf2 Link to goals 10 months ago
acceptreject.py ae5b9f579f flake8 style 3 months ago
announce.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
auth.py db64ceb87d Tidying 1 day ago
availability.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
blocking.py e75f1a0abb Remove carriage returns 1 month ago
blog.py e81f7e618e Remove the CW button from blog posts 1 week ago
blurhash.py 51db9230ae Static analysis on all source files 3 months ago
bookmarks.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
cache.py b2dbdfff7d Tidying 2 months ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 8 months ago
capabilities.py ba493f9e20 flake8 format 3 months ago
code-of-conduct.md 8efa97296b Mention casteism 8 months ago
config.py a70793b616 flake8 style 3 months ago
content.py 4c14d4a649 Remove html from searched profile descriptions 2 days ago
daemon.py db64ceb87d Tidying 1 day ago
default_about.txt 91981c7953 About screen 10 months ago
default_tos.txt 9b66d96a89 from 5 months ago
delete.py 0e3c41db2b When deleting a post also remove it from the recent posts cache in memory 2 weeks ago
donate.py be39532262 Remove donation url if invalid 4 days ago
epicyon-blog.css 9fb5eec345 Image corner radius on blog 4 weeks ago
epicyon-calendar.css eac7c0855c LCD icon tweaks 1 month ago
epicyon-follow.css 2bc159b7a3 Tidying 6 days ago
epicyon-login.css 2dc3a7302c Set border width from theme 1 month ago
epicyon-notification 451714e280 Likes notification 1 day ago
epicyon-profile.css 2bc159b7a3 Tidying 6 days ago
epicyon-suspended.css 2dc3a7302c Set border width from theme 1 month ago
epicyon.py 7b06a3b262 Plotting federated instances 1 day ago
filters.py e75f1a0abb Remove carriage returns 1 month ago
follow.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
followingCalendar.py 5dbd2ad076 Create calendar file 6 days ago
git.py dc68e2c20b Extract patch description 2 months ago
happening.py e75f1a0abb Remove carriage returns 1 month ago
httpsig.py 844f898b94 flake8 format 3 months ago
i2pdomain 504bcef679 i2p domain utility 4 weeks ago
inbox.py ac0dd52c78 Check for repeated like notifications 1 day ago
jsonldsig.py 43d259d2d7 Comment 3 weeks ago
like.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
manualapprove.py e75f1a0abb Remove carriage returns 1 month ago
matrix.py e2e2db91d4 flake8 format 3 months ago
media.py db64ceb87d Tidying 1 day ago
metadata.py 295814cd9b flake8 format 3 months ago
migrate.py 08a1b05a76 flake8 format 3 months ago
ocaps.md 12072b57e1 Separate ocaps document 11 months ago
outbox.py 0e3c41db2b When deleting a post also remove it from the recent posts cache in memory 2 weeks ago
person.py db64ceb87d Tidying 1 day ago
petnames.py dccf0f8a6c Remove debug 1 week ago
pgp.py dd8650b717 Remove email address if invalid 4 days ago
posts.py 22ca09caef Tidying 1 day ago
question.py 3334cc0466 flake8 format 3 months ago
roles.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
schedule.py 35438c0fc8 Generalise proxying 1 month ago
security_audit 6fbba92427 Security audit script 1 day ago
session.py a7dc83813c Tidying 1 week ago
shares.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
skills.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
socnet.py 7b06a3b262 Plotting federated instances 1 day ago
ssb.py 1a347ac878 Remove ssb address if invalid 4 days ago
static_analysis 51db9230ae Static analysis on all source files 3 months ago
tests.py 31e40671a9 Remove debug 1 day ago
theme.py 9baf7debde Convert ttf to woff2 1 week ago
threads.py ad2c26eebf flake8 format 3 months ago
tox.py bacc38eff2 Remove tox address if invalid 4 days ago
utils.py db64ceb87d Tidying 1 day ago
webfinger.py ee70877aeb Check that webfinger returns a dict 2 weeks ago
webinterface.py 4c09983932 Avoid showing large numbers of likes 1 day ago
xmpp.py d203262084 Remove XMPP address if invalid 4 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. It contains no javascript and uses HTML+CSS with a Python backend.

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 bandit
sudo pip3 install pyLD pyqrcode pypng

Or on Debian:

sudo apt install -y \
    tor python3-socks imagemagick \
    python3-numpy python3-setuptools \
    python3-crypto python3-pycryptodome \
    python3-dateutil python3-pil.imagetk
    python3-idna python3-requests \
    python3-pyld python3-django-timezone-field \
    libimage-exiftool-perl python3-flake8 \
    python3-pyqrcode python3-png python3-bandit \
    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 a security audit

To run a security audit:

./security_audit

Note that not all of the issues identified will necessarily be relevant to this project.

Installing on Onion or i2p domains

If you don't have access to the clearnet, or prefer not to use it, then it's possible to run an Epicyon instance easily from your laptop. There are scripts within the deploy directory which can be used to install an instance on a Debian or Arch/Parabola operating system. With some modification of package names they could be also used with other distros.

Please be aware that such installations will not federate with ordinary fediverse instances on the clearnet, unless those instances have been specially modified to do so. But onion instances will federate with other onion instances and i2p instances with other i2p instances.

Custom Fonts

If you want to use a particular font then copy it into the fonts directory, rename it as custom.ttf/woff/woff2/otf and then restart the epicyon daemon.

systemctl restart epicyon

Custom Favicon

If you want to use your own favicon then copy your favicon.ico file to the base directory where you installed Epicyon.

Adding Themes

If you want to add a new theme then open theme.py and add the theme name to the list within getThemesList. Add a function with the name setTheme[YourThemeName]. Have a look at the other themes to get an idea of how to set the colors and fonts.

Add the name of your theme to the translations files.

Within the img directory add a default profile background image called image_[YourThemeName].png and a banner image banner_[YourThemeName].png. Because the banner image will be reloaded occasionally it should be small - preferably kilobytes rather than megabytes.

On a running instance you can experiment with colors or fonts by editing epicyon.css and then reloading the web page. Once you are happy with the results then you can update the changed values within your setTheme function.

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