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 e68e2b56c7 Avoid colliding newswire feed items which are published on the hour 9 hours ago
architecture Update diagrams 3 months ago
cwlists Fix unit test 3 months ago
defaultcategories Update default categories 1 month ago
defaultwelcome Swahili language 8 months ago
deploy Don't need webserver cache 2 months ago
emoji Emoji reaction picker screen 3 months ago
fonts Update fonts 20 hours ago
gemini/EN Community not audience 3 months ago
img rc3 screenshot 1 month ago
ontology Publication ontology 5 months ago
scripts Emoji reaction notifications 2 months ago
theme Change logo 2 months ago
translations Dyslexic font checkbox in theme settings 21 hours ago
website/EN rc3 screenshot 1 month ago
.datignore Ignore file for dat 2 years ago
.gitignore Ignore package install files 12 months ago
.gitlab-ci.yml Extra ci dependency 5 months ago
CONTRIBUTING.md Change domain to libreserver.org 5 months ago
CONTRIBUTORS.md Add contributors list 2 years ago
Dockerfile Use bullseye dockerfile 6 months ago
LICENSE Initial 3 years ago
Makefile Snake case 1 month ago
README.md rc3 screenshot 1 month ago
README_architecture.md Web frameworks 3 months ago
README_commandline.md Remove role delegation 9 months ago
README_customizations.md Typos in various README files fixed 11 months ago
README_desktop_client.md Desktop client screenshot 2 months ago
README_goals.md readme updates 6 months ago
README_roadmap.md Update roadmap 3 months ago
__init__.py Use package directory to namespace modules 12 months ago
acceptreject.py Snake case 4 weeks ago
announce.py Snake case 4 weeks ago
auth.py Snake case 4 weeks ago
availability.py Snake case 4 weeks ago
blocking.py Use enumerations 3 weeks ago
blog.py Snake case 3 weeks ago
bookmarks.py Snake case 4 weeks ago
briar.py Snake case 4 weeks ago
cache.py Snake case 4 weeks ago
caddy.example.conf Caddy header 5 months ago
categories.py Snake case 4 weeks ago
city.py Snake case 4 weeks ago
code-of-conduct.md Add anti-trade union as a discrimination category 2 weeks ago
content.py Extra removal 2 weeks ago
context.py Snake case 4 weeks ago
conversation.py Snake case 4 weeks ago
cwtch.py Snake case 4 weeks ago
daemon.py Simplify 21 hours ago
default_about.md Default about 1 month ago
default_tos.md Redundant wording 1 month ago
defaultthemes.txt Don't overwrite default themes during import 8 months ago
delete.py Snake case 4 weeks ago
desktop_client.py Snake case 3 weeks ago
devices.py Snake case 4 weeks ago
donate.py Snake case 4 weeks ago
enigma.py Snake case 4 weeks ago
epicyon-blog.css Tiny blog screen 2 months ago
epicyon-calendar.css Tiny calendar screen 2 months ago
epicyon-follow.css Tiny emoji search screen 2 months ago
epicyon-graph.css Zero 3 months ago
epicyon-links.css Tiny links screen 2 months ago
epicyon-login.css Tiny login screen 2 months ago
epicyon-options.css Tiny options screen 2 months ago
epicyon-podcast.css Video podcast style 2 weeks ago
epicyon-profile.css Set audio player width within posts 2 weeks ago
epicyon-search.css Tiny search bar 2 months ago
epicyon-suspended.css Crisp rendering on pixel theme 11 months ago
epicyon-welcome.css Tiny welcome screen 2 months ago
epicyon.py Set dyslexic font during theme change 21 hours ago
feeds.py Moving to snake case 4 weeks ago
filters.py Snake case 4 weeks ago
fitnessFunctions.py Snake case 4 weeks ago
follow.py Snake case 2 weeks ago
followingCalendar.py Snake case 4 weeks ago
git.py Snake case 4 weeks ago
happening.py Snake case 4 weeks ago
hashtagrules.txt From operator in hashtag rules 1 year ago
httpsig.py Snake case 4 weeks ago
i2pdomain Change domain to libreserver.org 5 months ago
inbox.py Get categories from podcast feeds 2 weeks ago
install-desktop-client Stream 11 months ago
jami.py Snake case 4 weeks ago
languages.py Snake case 4 weeks ago
like.py Snake case 4 weeks ago
linked_data_sig.py Snake case 4 weeks ago
locations.txt Locations 8 months ago
locations_nogo.txt Extra nogo area 8 months ago
manualapprove.py Snake case 4 weeks ago
markdown.py Snake case 4 weeks ago
mastoapiv1.py Snake case 4 weeks ago
matrix.py Snake case 3 weeks ago
media.py Snake case 3 weeks ago
metadata.py Snake case 3 weeks ago
migrate.py Snake case 3 weeks ago
newsdaemon.py Get categories from podcast feeds 2 weeks ago
newswire.py Avoid colliding newswire feed items which are published on the hour 9 hours ago
notifyOnPost.py Snake case 3 weeks ago
outbox.py Use enumerations 3 weeks ago
person.py Use enumerations 3 weeks ago
petnames.py Snake case 3 weeks ago
pgp.py Snake case 3 weeks ago
posts.py Snake case 3 weeks ago
principlesofunity.md Convert to markdown 2 months ago
pyjsonld.py Moving to snake case 4 weeks ago
pyproject.toml Add setuptools package files 12 months ago
question.py Snake case 4 weeks ago
reaction.py Snake case 4 weeks ago
roles.py Use enumerations 3 weeks ago
schedule.py Snake case 4 weeks ago
security_audit Security audit script 2 years ago
session.py Check that string looks like a url when downloading image 3 weeks ago
setup.cfg Change domain to libreserver.org 5 months ago
setup.py Add stub setup.py 12 months ago
shares.py Snake case 3 weeks ago
siteactive.py Snake case 3 weeks ago
skills.py Snake case 3 weeks ago
socnet.py Snake case 3 weeks ago
speaker.py Use enumerations 3 weeks ago
ssb.py Snake case 3 weeks ago
static_analysis Static analysis on all source files 2 years ago
tests.py Avoid colliding newswire feed items which are published on the hour 9 hours ago
theme.py Set dyslexic font during theme change 21 hours ago
threads.py Snake case 3 weeks ago
tox.py Snake case 3 weeks ago
utils.py Get categories from podcast feeds 2 weeks ago
video.py Snake case 3 weeks ago
webapp_about.py Snake case 3 weeks ago
webapp_accesskeys.py Snake case 3 weeks ago
webapp_calendar.py Snake case 3 weeks ago
webapp_column_left.py Snake case 3 weeks ago
webapp_column_right.py Improve detection of podcast mime type 2 weeks ago
webapp_confirm.py Snake case 4 weeks ago
webapp_create_post.py Wording for creating news reports 3 weeks ago
webapp_frontscreen.py Snake case 3 weeks ago
webapp_hashtagswarm.py Snake case 3 weeks ago
webapp_headerbuttons.py Snake case 3 weeks ago
webapp_login.py Snake case 3 weeks ago
webapp_media.py Mime type for youtube videos 2 weeks ago
webapp_minimalbutton.py Snake case 3 weeks ago
webapp_moderation.py Snake case 3 weeks ago
webapp_person_options.py Add web address to person options 3 weeks ago
webapp_podcast.py Tidying 2 weeks ago
webapp_post.py Snake case 3 weeks ago
webapp_profile.py Dyslexic font checkbox in theme settings 21 hours ago
webapp_question.py Moving to snake case 4 weeks ago
webapp_search.py Use enumerations 3 weeks ago
webapp_suspended.py Snake case 3 weeks ago
webapp_theme_designer.py Snake case 3 weeks ago
webapp_timeline.py Snake case 3 weeks ago
webapp_tos.py Snake case 3 weeks ago
webapp_utils.py Snake case 3 weeks ago
webapp_welcome.py Snake case 3 weeks ago
webapp_welcome_final.py Snake case 3 weeks ago
webapp_welcome_profile.py Snake case 3 weeks ago
webfinger.py Snake case 3 weeks ago
xmpp.py Snake case 3 weeks 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.

Corporate social media gives you an audience, with reach, celebrity, spectacle, lack of control, professional influencers, anxiety, alienation and competition. It's designed for fast growth regardless of social consequences. Epicyon is designed for community, in which you have voice, agency, discussions and comradery. The community approach is the better way to build a habitable internet for the long term.

Project Goals - Commandline interface - Customizations - Software Architecture - Code of Conduct - Principles of Unity - C2S Desktop Client

Matrix room: #epicyon:matrix.libreserver.org

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;

    gzip on;
    gzip_disable "msie6";
    gzip_vary on;
    gzip_proxied any;
    gzip_min_length 1024;
    gzip_comp_level 6;
    gzip_buffers 16 8k;
    gzip_http_version 1.1;
    gzip_types text/plain text/css application/json application/ld+json application/javascript text/xml application/xml application/rdf+xml application/xml+rss text/javascript;

    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_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA;
    ssl_prefer_server_ciphers on;
    ssl_session_cache shared:SSL:10m;
    ssl_session_tickets off;

    add_header Content-Security-Policy "default-src https:; script-src https: 'unsafe-inline'; style-src https: 'unsafe-inline'";
    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 Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always;

    access_log /dev/null;
    error_log /dev/null;

    index index.html;

    location /newsmirror {
        root /var/www/YOUR_DOMAIN;
        try_files $uri =404;
    }

    keepalive_timeout 70;
    sendfile on;

    location / {
        proxy_http_version 1.1;
        client_max_body_size 31M;
        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;
        proxy_pass http://localhost:7156;
        tcp_nodelay on;
    }
}

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