Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar, news and sharing economy features to empower your federated community. We are using it for a hyper local indymedia codebase.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Bob Mottram 773208bffd Always get pages for http requests 15 hours ago
architecture Update architecture diagrams 5 days ago
defaultcategories Update default categories 2 weeks ago
defaultwelcome Swahili language 1 month ago
deploy Remove unused package from documentation 5 months ago
emoji freebsd emoji 2 months ago
fonts Minitel font 2 months ago
gemini/EN Update documentation for cache 1 month ago
img lynx screenshot 5 months ago
ontology Assign product Ids to shared items 1 week ago
scripts Tidying 3 weeks ago
theme Increase font size 1 week ago
translations Indicate minimum password length 4 days ago
website/EN Update documentation for cache 1 month ago
.datignore Ignore file for dat 1 year ago
.gitignore Ignore package install files 6 months ago
.gitlab-ci.yml Update cryptography dependency for CI 5 months ago
CONTRIBUTING.md Contributing file 1 year ago
CONTRIBUTORS.md Add contributors list 1 year ago
Dockerfile Use bullseye dockerfile 1 week ago
LICENSE Initial 2 years ago
Makefile No datashards 1 month ago
README.md Architecture linked from main README 1 month ago
README_architecture.md Accessibility architecture 1 month ago
README_commandline.md Remove role delegation 2 months ago
README_customizations.md Typos in various README files fixed 4 months ago
README_desktop_client.md Separate readme for desktop client 2 months ago
README_goals.md Typos in various README files fixed 4 months ago
README_roadmap.md Roadmap 1 month ago
__init__.py Use package directory to namespace modules 6 months ago
acceptreject.py Fixing --posts option 22 hours ago
announce.py Check for group account when sending posts 1 day ago
auth.py Shared item federation tokens stored as json 1 week ago
availability.py Detecting group handle 2 days ago
blocking.py Function for account directory 2 weeks ago
blog.py Tidying 1 week ago
bookmarks.py Detecting group handle 2 days ago
briar.py Module groups 1 month ago
cache.py Unit test for following a group 1 day ago
caddy.example.conf Caddy web server configuration 1 year ago
categories.py Fix test 2 weeks ago
city.py Define city variable 1 week ago
code-of-conduct.md Update code of conduct 3 months ago
content.py Function for account directory 2 weeks ago
context.py Module groups 1 month ago
cwtch.py cwtch address in profile 1 month ago
daemon.py Always get pages for http requests 15 hours ago
default_about.md Default about text 5 months ago
default_tos.md Remove lines 5 months ago
defaultthemes.txt Don't overwrite default themes during import 2 months ago
delete.py Detecting group handle 2 days ago
desktop_client.py Handling of understood languages prior to automatic translation 1 week ago
devices.py Function for account directory 2 weeks ago
donate.py Module groups 1 month ago
epicyon-blog.css Option to have round avatars 2 months ago
epicyon-calendar.css Calendar item styles for public or private 4 months ago
epicyon-follow.css Crisp rendering on pixel theme 5 months ago
epicyon-links.css Option to have round avatars 2 months ago
epicyon-login.css Crisp rendering on pixel theme 5 months ago
epicyon-options.css Button font size 2 months ago
epicyon-profile.css Password input styling 1 week ago
epicyon-search.css Crisp rendering on pixel theme 5 months ago
epicyon-suspended.css Crisp rendering on pixel theme 5 months ago
epicyon-welcome.css Markdown image style 5 months ago
epicyon.py More debug 16 hours ago
feeds.py Tidying 4 weeks ago
filters.py Filter federated shared items 4 days ago
follow.py Fixing --posts option 22 hours ago
followingCalendar.py Support language within contentMap 2 weeks ago
git.py Function for account directory 2 weeks ago
happening.py Improve handling of contentMap within posts 2 weeks ago
hashtagrules.txt From operator in hashtag rules 9 months ago
httpsig.py Argument types 1 month ago
i2pdomain i2p domain utility 1 year ago
inbox.py Fixing --posts option 22 hours ago
install-desktop-client Stream 4 months ago
jami.py Module groups 1 month ago
languages.py Tidying 1 week ago
like.py Check for group account when sending posts 1 day ago
linked_data_sig.py Module groups 1 month ago
locations.txt Locations 1 month ago
locations_nogo.txt Extra nogo area 1 month ago
manualapprove.py Group prefixes when follower approval is enabled 1 day ago
markdown.py Tidying 4 weeks ago
mastoapiv1.py Publish directory on mastodon api 1 day ago
matrix.py Module groups 1 month ago
media.py Handling of understood languages prior to automatic translation 1 week ago
metadata.py Module groups 1 month ago
migrate.py Unit test for following a group 1 day ago
newsdaemon.py Handling of understood languages prior to automatic translation 1 week ago
newswire.py Handling of understood languages prior to automatic translation 1 week ago
notifyOnPost.py Function for account directory 2 weeks ago
outbox.py Send shared items token to domains within the approved federation 6 days ago
person.py Debug for invalid box name 19 hours ago
petnames.py Function for account directory 2 weeks ago
pgp.py Detecting group handle 2 days ago
posts.py Fix removal of post interactions 16 hours ago
principlesofunity.txt Remove brackets 9 months ago
pyjsonld.py Tidying 2 weeks ago
pyproject.toml Add setuptools package files 6 months ago
question.py File open attribute style 2 weeks ago
roles.py Function for account directory 2 weeks ago
schedule.py Send shared items token to domains within the approved federation 6 days ago
security_audit Security audit script 1 year ago
session.py Tidying 2 weeks ago
setup.cfg Pypi: bump minor version for crypto changes 5 months ago
setup.py Add stub setup.py 5 months ago
shares.py Detecting group handle 2 days ago
siteactive.py Tidying 2 weeks ago
skills.py Detecting group handle 2 days ago
socnet.py Detecting group handle 2 days ago
speaker.py Function for account directory 2 weeks ago
ssb.py Module groups 1 month ago
static_analysis Tidying 3 months ago
tests.py Fix removal of post interactions 16 hours ago
theme.py Function for account directory 2 weeks ago
threads.py Tidying 2 weeks ago
tox.py Module groups 1 month ago
utils.py Fixing --posts option 22 hours ago
webapp_about.py Move markdown functions to a separate module 1 month ago
webapp_accesskeys.py Function for account directory 2 weeks ago
webapp_calendar.py Function for account directory 2 weeks ago
webapp_column_left.py Open left column shared item in same tab 4 days ago
webapp_column_right.py Handling of understood languages prior to automatic translation 1 week ago
webapp_confirm.py Remove debug 4 days ago
webapp_create_post.py Required price field 5 days ago
webapp_frontscreen.py Include federated shared items within shares timeline 5 days ago
webapp_hashtagswarm.py Tidying 3 weeks ago
webapp_headerbuttons.py Function for account directory 2 weeks ago
webapp_login.py Same maximum username length as mastodon 3 days ago
webapp_media.py Tidying 2 weeks ago
webapp_minimalbutton.py Function for account directory 2 weeks ago
webapp_moderation.py Include federated shared items within shares timeline 5 days ago
webapp_person_options.py Function for account directory 2 weeks ago
webapp_post.py Detecting group handle 2 days ago
webapp_profile.py More debug 22 hours ago
webapp_question.py Function for account directory 2 weeks ago
webapp_search.py Change history search prefix so that it can be used for groups 4 days ago
webapp_suspended.py Tidying 3 weeks ago
webapp_timeline.py More debug 16 hours ago
webapp_tos.py Move markdown functions to a separate module 1 month ago
webapp_utils.py No remove button on federated shared items 4 days ago
webapp_welcome.py Function for account directory 2 weeks ago
webapp_welcome_final.py Tidying 3 weeks ago
webapp_welcome_profile.py Move edit functions to utils module 1 week ago
webfinger.py Detecting group handle 2 days ago
xmpp.py Module groups 1 month 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 - 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