Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar and sharing economy features to empower your federated community. https://code.freedombone.net/bashrc/epicyon Docs: https://epicyon.net/#install
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 10492581ff Fix new http signature test 2 weeks ago
defaultcategories Update default categories 1 month ago
defaultwelcome Translations 1 month ago
deploy Remove unused package from documentation 2 months ago
emoji Test that all emojis have images 1 month ago
fonts Add pixel font 2 months ago
gemini/EN Remove unused package from documentation 2 months ago
img lynx screenshot 2 months ago
orgs Comma 1 year ago
scripts Notification flags on speaker endpoint 1 month ago
theme Different notification sounds 1 month ago
translations Don't show ciphertext in the web interface 1 month ago
website/EN Meta tags on website 2 months ago
.datignore Ignore file for dat 11 months ago
.gitignore Ignore package install files 2 months ago
.gitlab-ci.yml Update cryptography dependency for CI 2 months ago
CONTRIBUTING.md Contributing file 1 year ago
CONTRIBUTORS.md Add contributors list 1 year ago
Dockerfile Using python3-cryptography 2 months ago
LICENSE Initial 1 year ago
Makefile Custom help text for indymedia themes 1 month ago
README.md Typos in various README files fixed 1 month ago
README_commandline.md Profile command can use handle 3 weeks ago
README_customizations.md Typos in various README files fixed 1 month ago
README_goals.md Typos in various README files fixed 1 month ago
README_roadmap.md Roadmap 7 months ago
__init__.py Use package directory to namespace modules 2 months ago
acceptreject.py Join activity has the same meaning as Follow 2 months ago
announce.py Smaller timeouts 4 weeks ago
auth.py Version 1.2.0 2 months ago
availability.py Improve c2s debug messages 1 month ago
blocking.py Add ignores collection to make mutes visible to c2s 1 month ago
blog.py Spell checking on textareas 1 month ago
bookmarks.py Refresh timeline after mute 4 weeks ago
briar.py Version 1.2.0 2 months ago
cache.py Check if actor has changed 2 months ago
caddy.example.conf Caddy web server configuration 1 year ago
categories.py More hashtag checks 2 months ago
code-of-conduct.md Mention casteism 1 year ago
content.py Another long lines failure case 1 month ago
context.py Litepub social context 2 months ago
daemon.py Gent nickname from path 3 weeks ago
default_about.md Default about text 1 month ago
default_tos.md Remove lines 1 month ago
delete.py Delete posts via desktop client 4 weeks ago
desktop_client.py Tidying 2 weeks ago
devices.py Version 1.2.0 2 months ago
donate.py Version 1.2.0 2 months ago
epicyon-blog.css Crisp rendering on pixel theme 2 months ago
epicyon-calendar.css Calendar item styles for public or private 1 month ago
epicyon-follow.css Crisp rendering on pixel theme 2 months ago
epicyon-links.css Crisp rendering on pixel theme 2 months ago
epicyon-login.css Crisp rendering on pixel theme 2 months ago
epicyon-options.css Crisp rendering on pixel theme 2 months ago
epicyon-profile.css Make video style consistent with image style 1 month ago
epicyon-search.css Crisp rendering on pixel theme 2 months ago
epicyon-suspended.css Crisp rendering on pixel theme 2 months ago
epicyon-welcome.css Markdown image style 1 month ago
epicyon.py Getting follow requests collection via c2s 3 weeks ago
feeds.py Version 1.2.0 2 months ago
filters.py Version 1.2.0 2 months ago
follow.py Tidying 3 weeks ago
followingCalendar.py Version 1.2.0 2 months ago
git.py Version 1.2.0 2 months ago
happening.py Private calendar events have a different background color 1 month ago
hashtagrules.txt From operator in hashtag rules 6 months ago
httpsig.py Fix new http signature test 2 weeks ago
i2pdomain i2p domain utility 10 months ago
inbox.py Tidying 3 weeks ago
install-desktop-client Stream 1 month ago
jami.py Version 1.2.0 2 months ago
like.py Smaller timeouts 4 weeks ago
linked_data_sig.py Move jsonld signatures to python3-cryptography 2 months ago
manualapprove.py Honk style users path 2 months ago
mastoapiv1.py Version 1.2.0 2 months ago
matrix.py Version 1.2.0 2 months ago
media.py Image filename 1 month ago
metadata.py Version 1.2.0 2 months ago
migrate.py Less verbose 1 month ago
newsdaemon.py Refresh newswire after removing or suspending an account 2 months ago
newswire.py Less verbose 1 month ago
outbox.py Ignore activity permitted in outbox 1 month ago
person.py Avoid print 1 month ago
petnames.py Version 1.2.0 2 months ago
pgp.py Simplify 1 month ago
posts.py Show replies 3 weeks ago
principlesofunity.txt Remove brackets 6 months ago
pyjsonld.py Handle exception in jsonld signature check 1 month ago
pyproject.toml Add setuptools package files 2 months ago
question.py Version 1.2.0 2 months ago
roles.py Improve c2s debug messages 1 month ago
schedule.py Outgoing media posts also go to the media timeline 1 month ago
security_audit Security audit script 9 months ago
session.py Refresh timeline after mute 4 weeks ago
setup.cfg Pypi: bump minor version for crypto changes 2 months ago
setup.py Add stub setup.py 2 months ago
shares.py Improve c2s debug messages 1 month ago
siteactive.py Improve checking of site active status 2 months ago
skills.py Improve c2s debug messages 1 month ago
socnet.py Less verbose when not in debug 1 month ago
speaker.py Fix speakable return values 3 weeks ago
ssb.py Version 1.2.0 2 months ago
static_analysis Tidying 2 weeks ago
tests.py Fix new http signature test 2 weeks ago
theme.py Check that directory exists 1 month ago
threads.py Version 1.2.0 2 months ago
tox.py Version 1.2.0 2 months ago
utils.py Check that cache entry exists before deleting 3 weeks ago
webapp_about.py About text rendering as html 1 month ago
webapp_calendar.py Calendar item styles for public or private 1 month ago
webapp_column_left.py About text rendering as html 1 month ago
webapp_column_right.py Spell checking on textareas 1 month ago
webapp_confirm.py Notification sounds 1 month ago
webapp_create_post.py Add autocomplete when creating posts 1 month ago
webapp_frontscreen.py Notification sounds 1 month ago
webapp_hashtagswarm.py Validation of categories 2 months ago
webapp_headerbuttons.py Outbox becomes sent 1 month ago
webapp_login.py Always use nickname only within login screen 2 weeks ago
webapp_media.py Video style 1 month ago
webapp_moderation.py Spell checking on textareas 1 month ago
webapp_person_options.py Spell checking on textareas 1 month ago
webapp_post.py Less verbose when not in debug 1 month ago
webapp_profile.py Remove newline 2 weeks ago
webapp_question.py Version 1.2.0 2 months ago
webapp_search.py themeName in wrong position 3 weeks ago
webapp_suspended.py Version 1.2.0 2 months ago
webapp_timeline.py themeName in wrong position 3 weeks ago
webapp_tos.py Terms of service in markdown format 1 month ago
webapp_utils.py Less verbose 1 month ago
webapp_welcome.py Allow theme specific welcome files 1 month ago
webapp_welcome_final.py Allow theme specific welcome files 1 month ago
webapp_welcome_profile.py Spell checking on textareas 1 month ago
webfinger.py Less verbose 1 month ago
xmpp.py Version 1.2.0 2 months 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
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 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-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 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