Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar, news and sharing economy features to empower your federated community. We spent a year testing this for a hyper local indymedia codebase.
 
 
 
 
 
Go to file
Bob Mottram a07d301583 Define city variable 2021-07-19 21:07:28 +01:00
architecture Accessibility architecture 2021-06-29 19:06:15 +01:00
defaultcategories Update default categories 2021-07-13 09:44:02 +01:00
defaultwelcome Swahili language 2021-06-06 12:16:46 +01:00
deploy Remove unused package from documentation 2021-02-04 18:40:54 +00:00
emoji freebsd emoji 2021-05-11 11:00:53 +01:00
fonts Minitel font 2021-05-21 13:40:28 +01:00
gemini/EN Update documentation for cache 2021-06-13 10:15:32 +01:00
img lynx screenshot 2021-02-08 13:22:18 +00:00
scripts Tidying 2021-07-06 22:53:55 +01:00
theme Starlight theme icon tweaks 2021-07-17 23:13:14 +01:00
translations Setting permitted post languages on edit profile screen 2021-07-18 19:02:36 +01:00
website/EN Update documentation for cache 2021-06-13 10:15:32 +01:00
.datignore Ignore file for dat 2020-05-18 09:42:30 +01:00
.gitignore Ignore package install files 2021-02-02 23:55:39 +01:00
.gitlab-ci.yml Update cryptography dependency for CI 2021-02-15 22:58:14 -05:00
CONTRIBUTING.md Contributing file 2019-11-29 10:47:18 +00:00
CONTRIBUTORS.md Add contributors list 2020-03-19 17:31:40 +00:00
Dockerfile Using python3-cryptography 2021-02-04 16:30:32 +00:00
LICENSE Initial 2019-06-28 19:55:29 +01:00
Makefile No datashards 2021-06-11 11:32:24 +01:00
README.md Architecture linked from main README 2021-06-28 17:45:17 +01:00
README_architecture.md Accessibility architecture 2021-06-29 19:06:15 +01:00
README_commandline.md Remove role delegation 2021-05-13 20:58:16 +01:00
README_customizations.md Typos in various README files fixed 2021-03-16 22:52:03 +01:00
README_desktop_client.md Separate readme for desktop client 2021-05-05 19:54:47 +01:00
README_goals.md Typos in various README files fixed 2021-03-16 22:52:03 +01:00
README_roadmap.md Roadmap 2021-06-27 11:19:14 +01:00
__init__.py Use package directory to namespace modules 2021-02-03 11:51:39 +01:00
acceptreject.py Function for account directory 2021-07-13 22:59:53 +01:00
announce.py Check for dictionary objects 2021-07-06 11:00:19 +01:00
auth.py Tidying 2021-07-13 16:49:29 +01:00
availability.py Function for account directory 2021-07-13 22:59:53 +01:00
blocking.py Function for account directory 2021-07-13 22:59:53 +01:00
blog.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
bookmarks.py Function for account directory 2021-07-13 22:59:53 +01:00
briar.py Module groups 2021-06-15 16:08:12 +01:00
cache.py Module groups 2021-06-26 12:16:41 +01:00
caddy.example.conf Caddy web server configuration 2019-11-12 21:50:15 +00:00
categories.py Fix test 2021-07-13 09:43:07 +01:00
city.py Define city variable 2021-07-19 21:07:28 +01:00
code-of-conduct.md Update code of conduct 2021-04-21 17:35:40 +01:00
content.py Function for account directory 2021-07-13 22:59:53 +01:00
context.py Module groups 2021-06-15 16:08:12 +01:00
cwtch.py cwtch address in profile 2021-06-27 12:48:03 +01:00
daemon.py Only show libretranslate options to admin account 2021-07-19 20:58:06 +01:00
default_about.md Default about text 2021-03-01 11:42:52 +00:00
default_tos.md Remove lines 2021-03-01 11:15:48 +00:00
defaultthemes.txt Don't overwrite default themes during import 2021-05-30 12:06:15 +01:00
delete.py Extra architecture graphs 2021-06-26 15:21:24 +01:00
desktop_client.py Use cached actors when checking understood languages 2021-07-19 09:46:21 +01:00
devices.py Function for account directory 2021-07-13 22:59:53 +01:00
donate.py Module groups 2021-06-15 16:08:12 +01:00
epicyon-blog.css Option to have round avatars 2021-05-05 13:08:42 +01:00
epicyon-calendar.css Calendar item styles for public or private 2021-03-07 17:08:43 +00:00
epicyon-follow.css Crisp rendering on pixel theme 2021-02-18 13:23:33 +00:00
epicyon-links.css Option to have round avatars 2021-05-05 13:08:42 +01:00
epicyon-login.css Crisp rendering on pixel theme 2021-02-18 13:23:33 +00:00
epicyon-options.css Button font size 2021-05-21 14:41:02 +01:00
epicyon-profile.css Font sizes 2021-05-21 19:30:24 +01:00
epicyon-search.css Crisp rendering on pixel theme 2021-02-18 13:23:33 +00:00
epicyon-suspended.css Crisp rendering on pixel theme 2021-02-18 13:23:33 +00:00
epicyon-welcome.css Markdown image style 2021-02-26 17:38:25 +00:00
epicyon.py Only show libretranslate options to admin account 2021-07-19 20:58:06 +01:00
feeds.py Tidying 2021-07-03 17:44:07 +01:00
filters.py Function for account directory 2021-07-13 22:59:53 +01:00
follow.py Function for account directory 2021-07-13 22:59:53 +01:00
followingCalendar.py Support language within contentMap 2021-07-18 10:55:49 +01:00
git.py Function for account directory 2021-07-13 22:59:53 +01:00
happening.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
hashtagrules.txt From operator in hashtag rules 2020-10-20 18:37:15 +01:00
httpsig.py Argument types 2021-06-20 12:28:35 +01:00
i2pdomain i2p domain utility 2020-06-11 10:25:02 +01:00
inbox.py Check that object type is a string 2021-07-19 10:07:20 +01:00
install-desktop-client Stream 2021-03-16 22:33:19 +00:00
jami.py Module groups 2021-06-15 16:08:12 +01:00
languages.py Support for libretranslate 2021-07-19 20:40:04 +01:00
like.py Extra architecture graphs 2021-06-26 15:21:24 +01:00
linked_data_sig.py Module groups 2021-06-15 16:08:12 +01:00
locations.txt Locations 2021-06-13 19:18:58 +01:00
locations_nogo.txt Extra nogo area 2021-06-11 20:02:55 +01:00
manualapprove.py Function for account directory 2021-07-13 22:59:53 +01:00
markdown.py Tidying 2021-07-03 21:15:34 +01:00
mastoapiv1.py Function for account directory 2021-07-13 22:59:53 +01:00
matrix.py Module groups 2021-06-15 16:08:12 +01:00
media.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
metadata.py Module groups 2021-06-15 16:08:12 +01:00
migrate.py Function for account directory 2021-07-13 22:59:53 +01:00
newsdaemon.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
newswire.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
notifyOnPost.py Function for account directory 2021-07-13 22:59:53 +01:00
outbox.py More checking for actor updates 2021-07-19 09:59:30 +01:00
person.py Check that language for incoming post is understood by the account 2021-07-18 19:33:53 +01:00
petnames.py Function for account directory 2021-07-13 22:59:53 +01:00
pgp.py Include User-Agent within POST 2021-06-20 14:39:53 +01:00
posts.py Use cached actors when checking understood languages 2021-07-19 09:46:21 +01:00
principlesofunity.txt Remove brackets 2020-10-18 22:35:10 +01:00
pyjsonld.py Tidying 2021-07-13 16:49:29 +01:00
pyproject.toml Add setuptools package files 2021-02-02 23:55:32 +01:00
question.py File open attribute style 2021-07-13 15:40:49 +01:00
roles.py Function for account directory 2021-07-13 22:59:53 +01:00
schedule.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
security_audit Security audit script 2020-07-08 15:28:08 +01:00
session.py Tidying 2021-07-13 16:49:29 +01:00
setup.cfg Pypi: bump minor version for crypto changes 2021-02-06 18:58:56 +01:00
setup.py Add stub setup.py 2021-02-15 22:50:06 -05:00
shares.py Function for account directory 2021-07-13 22:59:53 +01:00
siteactive.py Tidying 2021-07-13 16:49:29 +01:00
skills.py Function for account directory 2021-07-13 22:59:53 +01:00
socnet.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
speaker.py Function for account directory 2021-07-13 22:59:53 +01:00
ssb.py Module groups 2021-06-15 16:08:12 +01:00
static_analysis Tidying 2021-04-04 12:58:48 +01:00
tests.py Test for getting understood languages string 2021-07-19 11:18:46 +01:00
theme.py Function for account directory 2021-07-13 22:59:53 +01:00
threads.py Tidying 2021-07-13 16:49:29 +01:00
tox.py Module groups 2021-06-15 16:08:12 +01:00
utils.py Support for libretranslate 2021-07-19 20:40:04 +01:00
webapp_about.py Move markdown functions to a separate module 2021-06-25 15:38:31 +01:00
webapp_accesskeys.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_calendar.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_column_left.py File open attribute style 2021-07-13 15:40:49 +01:00
webapp_column_right.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
webapp_confirm.py Support for contentMap when creating html posts 2021-07-18 12:48:29 +01:00
webapp_create_post.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_frontscreen.py Support for contentMap when creating html posts 2021-07-18 12:48:29 +01:00
webapp_hashtagswarm.py Tidying 2021-07-05 21:24:43 +01:00
webapp_headerbuttons.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_login.py Function for checking url prefixes 2021-07-06 10:44:45 +01:00
webapp_media.py Tidying 2021-07-13 16:49:29 +01:00
webapp_minimalbutton.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_moderation.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
webapp_person_options.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_post.py Support for libretranslate 2021-07-19 20:40:04 +01:00
webapp_profile.py Generating cities dropdown when no city file exists 2021-07-19 21:05:20 +01:00
webapp_question.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_search.py Improve handling of contentMap within posts 2021-07-18 15:15:16 +01:00
webapp_suspended.py Tidying 2021-07-06 13:50:38 +01:00
webapp_timeline.py Support for contentMap when creating html posts 2021-07-18 12:48:29 +01:00
webapp_tos.py Move markdown functions to a separate module 2021-06-25 15:38:31 +01:00
webapp_utils.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_welcome.py Function for account directory 2021-07-13 22:59:53 +01:00
webapp_welcome_final.py Tidying 2021-07-06 13:50:38 +01:00
webapp_welcome_profile.py Function for account directory 2021-07-13 22:59:53 +01:00
webfinger.py Webfinger removal based upon alias 2021-07-06 14:17:38 +01:00
xmpp.py Module groups 2021-06-15 16:08:12 +01:00

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