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 dff6fe932a Comma 1 month ago
defaultcategories Update default categories 1 month ago
deploy Update onion deployment 2 months ago
emoji Comma 1 month ago
fonts Orbitron secondary font 2 months ago
gemini/EN Add wget to dependencies 2 months ago
img Move banners to theme directories 2 months ago
orgs Comma 1 year ago
scripts Clear mirrored news 2 months ago
theme Event icon 1 month ago
translations Account info screen 1 month ago
website/EN Media timeline screenshot 2 months ago
.datignore Ignore file for dat 8 months ago
.gitlab-ci.yml Add gitlab CI 10 months ago
CONTRIBUTING.md Contributing file 1 year ago
CONTRIBUTORS.md Add contributors list 10 months ago
Dockerfile Dependency not needed 3 months ago
LICENSE Initial 1 year ago
Makefile Indymedia theme 4 months ago
README.md Digital pets emoji 1 month ago
README_commandline.md Plotting federated instances 6 months ago
README_customizations.md Update documentation for themes 1 year ago
README_goals.md Remove capabilities from documentation 3 months ago
README_roadmap.md Roadmap 4 months ago
acceptreject.py Remove extra parameter 3 months ago
announce.py Remove capabilities 3 months ago
auth.py Lower case 1 month ago
availability.py Remove capabilities 3 months ago
blocking.py Check for blocked hashtag with hash prefix 1 month ago
blog.py Remove icons path variable 1 month ago
blurhash.py Static analysis on all source files 9 months ago
bookmarks.py Remove capabilities 3 months ago
cache.py Check that Url being stored is an actor 1 month ago
caddy.example.conf Caddy web server configuration 1 year ago
code-of-conduct.md Mention casteism 1 year ago
content.py Standardize rel 1 month ago
daemon.py Remove any html from nickname and bio 1 month ago
default_about.txt About screen 1 year ago
default_tos.txt Change title 2 months ago
delete.py Splitting webapp into smaller modules 2 months ago
devices.py Store uploaded device key 5 months ago
donate.py Avoid arbitrary html being added to profile fields 1 month ago
epicyon-blog.css No news flag 1 month ago
epicyon-calendar.css Stay normal while hovering 1 month ago
epicyon-follow.css Undecorated links 1 month ago
epicyon-links.css Set header font size 1 month ago
epicyon-login.css Login screen background color 1 month ago
epicyon-notification Go straight to followers list after receiving follow approval notification 6 months ago
epicyon-options.css Options screen link background 1 month ago
epicyon-profile.css More indentation 1 month ago
epicyon-search.css Button style 1 month ago
epicyon-suspended.css Undecorated links 1 month ago
epicyon.py Account info screen 1 month ago
feeds.py Migrating functions from webapp 2 months ago
filters.py File write style 6 months ago
follow.py Moving functions out of webapp 2 months ago
followingCalendar.py Unit test for adding new follow to calendar 4 months ago
git.py Directories must be created first 4 months ago
happening.py Directories must be created first 4 months ago
hashtagrules.txt From operator in hashtag rules 2 months ago
httpsig.py flake8 format 9 months ago
i2pdomain i2p domain utility 7 months ago
inbox.py Spaces 1 month ago
jami.py Avoid arbitrary html being added to profile fields 1 month ago
jsonldsig.py Avoid pyld dependency 3 months ago
like.py Remove capabilities 3 months ago
manualapprove.py Inverting the logic makes more sense 2 months ago
matrix.py Avoid arbitrary html being added to profile fields 1 month ago
media.py Tidying 1 month ago
metadata.py flake8 format 9 months ago
migrate.py File write style 6 months ago
newsdaemon.py Tidying 1 month ago
newswire.py Ensure that there isn't any html in feed text 1 month ago
outbox.py Prevent sending content with dangerous markup via the outbox 1 month ago
person.py Features timeline function 1 month ago
petnames.py Create default petname when following 1 month ago
pgp.py Avoid arbitrary html being added to profile fields 1 month ago
posts.py Remove html from display name 1 month ago
principlesofunity.txt Remove brackets 2 months ago
pyjsonld.py Check that property exists 1 month ago
question.py Moving functions out of webapp 2 months ago
roles.py Tidying 1 month ago
schedule.py Youtube replacement domain is configurable 5 months ago
security_audit Security audit script 6 months ago
session.py Move rss functions 3 months ago
shares.py Tidy up the handling of media formats 1 month ago
skills.py Remove capabilities 3 months ago
socnet.py Remove capabilities 3 months ago
ssb.py Avoid arbitrary html being added to profile fields 1 month ago
static_analysis Static analysis on all source files 9 months ago
tests.py Too much date checking 1 month ago
theme.py Tidy up the handling of media formats 1 month ago
threads.py flake8 format 9 months ago
tox.py Avoid arbitrary html being added to profile fields 1 month ago
utils.py Create tags directory if needed 1 month ago
webapp_about.py Move to external css 2 months ago
webapp_calendar.py Remove icons path variable 1 month ago
webapp_column_left.py Standardize rel 1 month ago
webapp_column_right.py Standardize rel 1 month ago
webapp_confirm.py Remove icons path argument 1 month ago
webapp_create_post.py Remove icons path argument 1 month ago
webapp_frontscreen.py Remove icons path argument 1 month ago
webapp_hashtagswarm.py Filter for recent hashtags on category screen 1 month ago
webapp_headerbuttons.py Remove icons path argument 1 month ago
webapp_login.py Move to external css 2 months ago
webapp_media.py Extra peertube site 1 month ago
webapp_moderation.py Separate link to actor 1 month ago
webapp_person_options.py Even if other instances include arbitrary html within profile tags it isn't rendered within person options 1 month ago
webapp_post.py Fewer spaces 1 month ago
webapp_profile.py Remove icons path argument 1 month ago
webapp_question.py Splitting webapp into smaller modules 2 months ago
webapp_search.py Remove icons path argument 1 month ago
webapp_suspended.py Move to external css 2 months ago
webapp_timeline.py Default moderation action 1 month ago
webapp_tos.py Move to external css 2 months ago
webapp_utils.py Avoid arbitrary html being added to profile fields 1 month ago
webfinger.py Don't insist on lowercase handle 4 months ago
xmpp.py Avoid arbitrary html being added to profile fields 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 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. 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-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 /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