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

Bob Mottram 5d5020a6e4 Script for blocked events 4 hours ago
defaultcategories 8285f268ec Update default hashtag categories 1 week ago
defaultwelcome 19069c7b1d Swahili language 1 week ago
deploy 6bbb23d594 Remove unused package from documentation 4 months ago
emoji 81df7cf699 freebsd emoji 1 month ago
fonts 9e4c9428c4 Minitel font 4 weeks ago
gemini 0aa6252077 Update documentation for cache 5 days ago
img d76d0083e8 lynx screenshot 4 months ago
scripts 5d5020a6e4 Script for blocked events 4 hours ago
theme e7ae1c0561 Importing themes 2 weeks ago
translations 19069c7b1d Swahili language 1 week ago
website 0aa6252077 Update documentation for cache 5 days ago
.datignore bd06a914d4 Ignore file for dat 1 year ago
.gitignore fb6f4b5b1b Ignore package install files 4 months ago
.gitlab-ci.yml 00094e53c6 Update cryptography dependency for CI 4 months ago
CONTRIBUTING.md 06ef125e89 Contributing file 1 year ago
CONTRIBUTORS.md 8463a118ef Add contributors list 1 year ago
Dockerfile d6f7ad20a3 Using python3-cryptography 4 months ago
LICENSE e5a03e0fe9 Initial 2 years ago
Makefile 23f564c730 No datashards 1 week ago
README.md 0aa6252077 Update documentation for cache 5 days ago
README_commandline.md 7e48beb0fe Remove role delegation 1 month ago
README_customizations.md 6280b71236 Typos in various README files fixed 3 months ago
README_desktop_client.md 2baf7f2a49 Separate readme for desktop client 1 month ago
README_goals.md 6280b71236 Typos in various README files fixed 3 months ago
README_roadmap.md 993a463c70 Roadmap 9 months ago
__init__.py 05705ded65 Use package directory to namespace modules 4 months ago
acceptreject.py ab7c2a9a66 Module groups 3 days ago
announce.py ab7c2a9a66 Module groups 3 days ago
auth.py ab7c2a9a66 Module groups 3 days ago
availability.py ab7c2a9a66 Module groups 3 days ago
blocking.py ab7c2a9a66 Module groups 3 days ago
blog.py ab7c2a9a66 Module groups 3 days ago
bookmarks.py ab7c2a9a66 Module groups 3 days ago
briar.py ab7c2a9a66 Module groups 3 days ago
cache.py ab7c2a9a66 Module groups 3 days ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 1 year ago
categories.py ab7c2a9a66 Module groups 3 days ago
city.py ab7c2a9a66 Module groups 3 days ago
code-of-conduct.md eaccc3f2e5 Update code of conduct 1 month ago
content.py e7ae1c0561 Importing themes 2 weeks ago
context.py ab7c2a9a66 Module groups 3 days ago
daemon.py 1224540e2c Max age of zero 5 days ago
default_about.md d70895c0cf Default about text 3 months ago
default_tos.md 768f2d4fe9 Remove lines 3 months ago
defaultthemes.txt f06d1b20b3 Don't overwrite default themes during import 2 weeks ago
delete.py ab7c2a9a66 Module groups 3 days ago
desktop_client.py c2bc98d4de Set host domain when getting actor 6 hours ago
devices.py 419353ccf9 Version 1.2.0 4 months ago
donate.py ab7c2a9a66 Module groups 3 days ago
epicyon-blog.css 0e93c781cc Option to have round avatars 1 month ago
epicyon-calendar.css 71dff77f20 Calendar item styles for public or private 3 months ago
epicyon-follow.css fd276e1d24 Crisp rendering on pixel theme 4 months ago
epicyon-links.css 0e93c781cc Option to have round avatars 1 month ago
epicyon-login.css fd276e1d24 Crisp rendering on pixel theme 4 months ago
epicyon-options.css a91ad77afc Button font size 4 weeks ago
epicyon-profile.css a26ef341f7 Font sizes 3 weeks ago
epicyon-search.css fd276e1d24 Crisp rendering on pixel theme 4 months ago
epicyon-suspended.css fd276e1d24 Crisp rendering on pixel theme 4 months ago
epicyon-welcome.css 2ad10b0700 Markdown image style 3 months ago
epicyon.py c2bc98d4de Set host domain when getting actor 6 hours ago
feeds.py ab7c2a9a66 Module groups 3 days ago
filters.py 34d2576ed2 Tidying 1 week ago
follow.py ab7c2a9a66 Module groups 3 days ago
followingCalendar.py ab7c2a9a66 Module groups 3 days ago
git.py ab7c2a9a66 Module groups 3 days ago
happening.py ab7c2a9a66 Module groups 3 days ago
hashtagrules.txt 89a9b8d7b3 From operator in hashtag rules 8 months ago
httpsig.py ab7c2a9a66 Module groups 3 days ago
i2pdomain 504bcef679 i2p domain utility 1 year ago
inbox.py ab7c2a9a66 Module groups 3 days ago
install-desktop-client 545f633ab1 Stream 3 months ago
jami.py ab7c2a9a66 Module groups 3 days ago
like.py ab7c2a9a66 Module groups 3 days ago
linked_data_sig.py ab7c2a9a66 Module groups 3 days ago
locations.txt 1a2b0374e5 Locations 4 days ago
locations_nogo.txt 9d3f0e213c Extra nogo area 6 days ago
manualapprove.py ab7c2a9a66 Module groups 3 days ago
mastoapiv1.py ab7c2a9a66 Module groups 3 days ago
matrix.py ab7c2a9a66 Module groups 3 days ago
media.py ab7c2a9a66 Module groups 3 days ago
metadata.py ab7c2a9a66 Module groups 3 days ago
migrate.py ab7c2a9a66 Module groups 3 days ago
newsdaemon.py ab7c2a9a66 Module groups 3 days ago
newswire.py ab7c2a9a66 Module groups 3 days ago
outbox.py ab7c2a9a66 Module groups 3 days ago
person.py c2bc98d4de Set host domain when getting actor 6 hours ago
petnames.py 419353ccf9 Version 1.2.0 4 months ago
pgp.py cdd0f91dfb Additional debug information on getJson 4 hours ago
posts.py ab7c2a9a66 Module groups 3 days ago
principlesofunity.txt 9538c0e40a Remove brackets 8 months ago
pyjsonld.py a19822ce5a Handle exception in jsonld signature check 3 months ago
pyproject.toml 7337b961c0 Add setuptools package files 4 months ago
question.py ab7c2a9a66 Module groups 3 days ago
roles.py da07855e97 Artist role 1 month ago
schedule.py ab7c2a9a66 Module groups 3 days ago
security_audit 6fbba92427 Security audit script 11 months ago
session.py 7c6e2c6961 Remove redundant check 4 hours ago
setup.cfg 0e08fa0d28 Pypi: bump minor version for crypto changes 4 months ago
setup.py 695a49b3e8 Add stub setup.py 4 months ago
shares.py ab7c2a9a66 Module groups 3 days ago
siteactive.py b16fb0d24c Improve checking of site active status 4 months ago
skills.py d7266136cc Additional validation prior to inbox queue 1 week ago
socnet.py faadca51b6 Less verbose when not in debug 3 months ago
speaker.py 40655f8b19 Fix speakable return values 2 months ago
ssb.py ab7c2a9a66 Module groups 3 days ago
static_analysis fd1b678e5e Tidying 2 months ago
tests.py ab7c2a9a66 Module groups 3 days ago
theme.py 8804849a8d Remove any previous temporary files 2 weeks ago
threads.py 419353ccf9 Version 1.2.0 4 months ago
tox.py ab7c2a9a66 Module groups 3 days ago
utils.py 4d849f33a8 Change paths for avatars and backgrounds to be similar to Mastodon icon/image 1 week ago
webapp_about.py ab7c2a9a66 Module groups 3 days ago
webapp_accesskeys.py ab7c2a9a66 Module groups 3 days ago
webapp_calendar.py ab7c2a9a66 Module groups 3 days ago
webapp_column_left.py ab7c2a9a66 Module groups 3 days ago
webapp_column_right.py ab7c2a9a66 Module groups 3 days ago
webapp_confirm.py ab7c2a9a66 Module groups 3 days ago
webapp_create_post.py ab7c2a9a66 Module groups 3 days ago
webapp_frontscreen.py ab7c2a9a66 Module groups 3 days ago
webapp_hashtagswarm.py ab7c2a9a66 Module groups 3 days ago
webapp_headerbuttons.py ab7c2a9a66 Module groups 3 days ago
webapp_login.py ab7c2a9a66 Module groups 3 days ago
webapp_media.py ab7c2a9a66 Module groups 3 days ago
webapp_moderation.py ab7c2a9a66 Module groups 3 days ago
webapp_person_options.py ab7c2a9a66 Module groups 3 days ago
webapp_post.py ab7c2a9a66 Module groups 3 days ago
webapp_profile.py c2bc98d4de Set host domain when getting actor 6 hours ago
webapp_question.py ab7c2a9a66 Module groups 3 days ago
webapp_search.py ab7c2a9a66 Module groups 3 days ago
webapp_suspended.py ab7c2a9a66 Module groups 3 days ago
webapp_timeline.py ab7c2a9a66 Module groups 3 days ago
webapp_tos.py ab7c2a9a66 Module groups 3 days ago
webapp_utils.py ab7c2a9a66 Module groups 3 days ago
webapp_welcome.py ab7c2a9a66 Module groups 3 days ago
webapp_welcome_final.py ab7c2a9a66 Module groups 3 days ago
webapp_welcome_profile.py ab7c2a9a66 Module groups 3 days ago
webfinger.py ab7c2a9a66 Module groups 3 days ago
xmpp.py ab7c2a9a66 Module groups 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 suitable for installation on single board computers. It includes features such as moderation tools, post expiry, content warnings, image descriptions, news feed and perimeter defense against adversaries. It contains no JavaScript and uses HTML+CSS with a Python backend.

Project Goals - Commandline interface - Customizations - 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. Digital Pets emoji were made by Tomcat94 and licensed under CC0.

Package Dependencies

You will need python version 3.7 or later.

On Arch/Parabola:

sudo pacman -S tor python-pip python-pysocks python-cryptography \
               imagemagick python-requests \
	       perl-image-exiftool python-dateutil \
	       certbot flake8 bandit
sudo pip3 install pyqrcode pypng

Or on Debian:

sudo apt install -y \
    tor python3-socks imagemagick \
    python3-setuptools \
    python3-cryptography \
    python3-dateutil \
    python3-idna python3-requests \
    python3-django-timezone-field \
    libimage-exiftool-perl python3-flake8 \
    python3-pyqrcode python3-png python3-bandit \
    certbot nginx wget

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

Link news mirrors:

mkdir /var/www/YOUR_DOMAIN
mkdir -p /opt/epicyon/accounts/newsmirror
ln -s /opt/epicyon/accounts/newsmirror /var/www/YOUR_DOMAIN/newsmirror

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 --logLoginFailures
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 /newsmirror {
        root /var/www/YOUR_DOMAIN;
        try_files $uri =404;
    }

    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;
        location ~ ^/accounts/(avatars|headers)/(.*).(png|jpg|gif|webp|svg) {
          expires 1d;
          proxy_pass http://localhost:7156;
        }
        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-v02.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 need to use fail2ban then failed login attempts can be found in accounts/loginfailures.log.

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. Consider its output as a list of things which potentially can be investigated but usually will turn out not to be relevant.

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.

Changing Themes

When changing themes you may need to ensure that your nginx cache is cleared (/var/www/cache/*) and that your local browser cache is cleared for the site (Shift + Reload). Otherwise images and icons from the previous theme may remain.

Adding Themes

If you want to add a new theme then first add the name of your theme to the translations files.

Within the theme directory create a directory with the name of your theme and add icons and banners. As a quick way to begin you could copy the contents of theme/default, then edit the graphics. Keep the size of images as small as possible to avoid creating a laggy user interface.

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 variable values within your theme/yourtheme/theme.json file.

Epicyon normally uses one set of CSS files whose variables are then altered per theme. If you want to use entirely bespoke CSS then copy epicyon-*.css into your theme directory and edit it to your requirements. This will be used rather than the default CSS files. Be warned that if you're maintaining the CSS files yourself then you may need to keep up with whatever changes are happening upstream, otherwise your user interface will break.

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