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

Bob Mottram 26f8c08c3f Theme colors 1 hour ago
deploy 24c1b2401c Update onion deployment 5 days ago
emoji 40d5aa1e59 Birdsite emoji 2 days ago
fonts 40c4e6e766 An extra font 1 month ago
gemini 06ab99a96c Add wget to dependencies 4 days ago
img 2790b2a22d Transparent background 1 hour ago
orgs e0c833dbba Comma 11 months ago
scripts 3d629a1287 Clear mirrored news 5 days ago
translations 9658eb1375 Start of indymedia modern theme 2 hours ago
website 06ab99a96c Add wget to dependencies 4 days ago
.datignore bd06a914d4 Ignore file for dat 5 months ago
.gitlab-ci.yml 74a4cb90c5 Add gitlab CI 7 months ago
CONTRIBUTING.md 06ef125e89 Contributing file 11 months ago
CONTRIBUTORS.md 8463a118ef Add contributors list 7 months ago
Dockerfile 0a2f9776c6 Dependency not needed 1 week ago
LICENSE e5a03e0fe9 Initial 1 year ago
Makefile b291619556 Indymedia theme 1 month ago
README.md 475c23f1fb Update readme 5 days ago
README_commandline.md 7b06a3b262 Plotting federated instances 3 months ago
README_customizations.md 9561f2a557 Update documentation for themes 11 months ago
README_goals.md 74b78a01f9 Remove capabilities from documentation 3 weeks ago
README_roadmap.md 993a463c70 Roadmap 1 month ago
acceptreject.py b55629c17a Remove extra parameter 3 weeks ago
announce.py 6435156179 Remove capabilities 3 weeks ago
auth.py e584076aca Unit test for constant time string check 1 month ago
availability.py 6435156179 Remove capabilities 3 weeks ago
blocking.py ee9d9a9dc5 Ability to mirror rss feed content 5 days ago
blog.py 67fa0b5a8f Don't include footer 1 week ago
blurhash.py 51db9230ae Static analysis on all source files 6 months ago
bookmarks.py 6435156179 Remove capabilities 3 weeks ago
cache.py 3179a37975 Tidying to reduce file reads 1 month ago
caddy.example.conf 9188d6fdcb Caddy web server configuration 11 months ago
code-of-conduct.md 8efa97296b Mention casteism 11 months ago
content.py c691cff82d Add hashtag interpreter 1 week ago
daemon.py 2db5f1637b Set timeline header style on theme change 6 hours ago
default_about.txt 91981c7953 About screen 1 year ago
default_tos.txt 9b66d96a89 from 9 months ago
delete.py 6435156179 Remove capabilities 3 weeks ago
devices.py 4a34ee0e80 Store uploaded device key 2 months ago
donate.py be39532262 Remove donation url if invalid 3 months ago
epicyon-blog.css 3797c06b62 More line spacing 1 month ago
epicyon-calendar.css fbe75d5c62 Extra css font 1 month ago
epicyon-follow.css fbe75d5c62 Extra css font 1 month ago
epicyon-links.css 093b13d413 Edit links icon style 3 weeks ago
epicyon-login.css 3797c06b62 More line spacing 1 month ago
epicyon-notification f6703325bd Go straight to followers list after receiving follow approval notification 3 months ago
epicyon-options.css 16f545fd21 Back button size 1 month ago
epicyon-profile.css 89e2b76901 Background for visited hashtags 1 day ago
epicyon-search.css fbe75d5c62 Extra css font 1 month ago
epicyon-suspended.css fbe75d5c62 Extra css font 1 month ago
epicyon.py 67a3ef538f Add option for timeline button header full screen width 6 hours ago
filters.py fe5e21ee7d File write style 3 months ago
follow.py a4e7ba2fa8 Tidying 12 hours ago
followingCalendar.py 949f54f5f3 Unit test for adding new follow to calendar 1 month ago
git.py 7635652ac5 Directories must be created first 1 month ago
happening.py 7635652ac5 Directories must be created first 1 month ago
hashtagrules.txt 89a9b8d7b3 From operator in hashtag rules 4 days ago
httpsig.py 844f898b94 flake8 format 6 months ago
i2pdomain 504bcef679 i2p domain utility 4 months ago
inbox.py fa419cf995 Option to set a maximum number of followers per account 1 day ago
jsonldsig.py f24514d3c1 Avoid pyld dependency 1 week ago
like.py 6435156179 Remove capabilities 3 weeks ago
manualapprove.py 98e1805930 Option to show mobile newswire publish as icon or button 8 hours ago
matrix.py e2e2db91d4 flake8 format 6 months ago
media.py e12b6483c3 Support AVIF image format 1 month ago
metadata.py 295814cd9b flake8 format 6 months ago
migrate.py fe5e21ee7d File write style 3 months ago
newsdaemon.py 742d112018 Hashtag backgrounds 1 day ago
newswire.py e521a95e18 Limit the maximum number of hashtags imported from newswire feeds 1 day ago
outbox.py 2899768828 Option to only show date at bottom of posts, not time 1 week ago
person.py 5085587ad4 Editing news posts 2 weeks ago
petnames.py fe5e21ee7d File write style 3 months ago
pgp.py dd8650b717 Remove email address if invalid 3 months ago
posts.py 32758ffe62 Option to archive news posts 3 days ago
principlesofunity.txt 9538c0e40a Remove brackets 6 days ago
pyjsonld.py 65f4e3ad41 Tidy up pyLD 1 week ago
question.py 7635652ac5 Directories must be created first 1 month ago
roles.py 7b616a4c70 Assigning site editors 1 week ago
schedule.py 83cac23229 Youtube replacement domain is configurable 2 months ago
security_audit 6fbba92427 Security audit script 3 months ago
session.py 4d4bdceb76 Move rss functions 2 weeks ago
shares.py 6435156179 Remove capabilities 3 weeks ago
skills.py 6435156179 Remove capabilities 3 weeks ago
socnet.py 6435156179 Remove capabilities 3 weeks ago
ssb.py 1a347ac878 Remove ssb address if invalid 3 months ago
static_analysis 51db9230ae Static analysis on all source files 6 months ago
tests.py 67a3ef538f Add option for timeline button header full screen width 6 hours ago
theme.py 26f8c08c3f Theme colors 1 hour ago
threads.py ad2c26eebf flake8 format 6 months ago
tox.py bacc38eff2 Remove tox address if invalid 3 months ago
utils.py 32758ffe62 Option to archive news posts 3 days ago
webfinger.py 99893e5e23 Don't insist on lowercase handle 1 month ago
webinterface.py 4b98d970be Missing parameter 5 hours ago
xmpp.py d203262084 Remove XMPP address if invalid 3 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 sutable 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.

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

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.

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