ActivityPub server, designed for simplicity and accessibility. Includes calendar, news and sharing economy features to empower your federated community.
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 77069b5e2e Merge branch 'main' of gitlab.com:bashrc2/epicyon 2 weeks ago
architecture Update architecture diagrams 1 month ago
cwlists Add spaces 2 months ago
defaultcategories Update default categories 3 weeks ago
defaultwelcome Start of Bengali language 4 months ago
deploy Tidying 2 months ago
emoji Extra emoji 4 months ago
fonts Update fonts 8 months ago
gemini/EN Stop nginx before cert generation 4 weeks ago
img Change logo 2 months ago
ontology Language support for clothing types 4 months ago
scripts Get ntfy files from account 1 month ago
specification Example emoji reaction 1 month ago
theme Selected page color 3 months ago
translations Colon 3 weeks ago
website/EN Stop nginx before cert generation 4 weeks ago
.datignore Ignore file for dat 2 years ago
.gitignore Ignore package install files 2 years ago
.gitlab-ci.yml Extra ci dependency 1 year ago
.woodpecker.yml Add '.woodpecker.yml' 4 months ago
CONTRIBUTING.md Change domain to libreserver.org 1 year ago
CONTRIBUTORS.md Add contributors list 3 years ago
Dockerfile Use bullseye dockerfile 1 year ago
LICENSE Initial 3 years ago
Makefile Clean cwlists 4 months ago
README.md Stop nginx before cert generation 4 weeks ago
README_architecture.md Architecture notes 6 months ago
README_coding_style.md Python version 4 months ago
README_commandline.md More explanation 1 month ago
README_customizations.md Changes for theme creation 6 months ago
README_desktop_client.md Support for mimic3 tts 3 months ago
README_goals.md Add NFTs as not being a goal 5 months ago
README_roadmap.md Update roadmap 11 months ago
__init__.py Use package directory to namespace modules 2 years ago
acceptreject.py Replace open with text in file function 4 months ago
announce.py Tidying 4 months ago
auth.py Function for line ending characters 3 months ago
availability.py Handle none return valued from nickname 6 months ago
blocking.py Check break after walk 2 months ago
blog.py Tidying 4 weeks ago
bookmarks.py Function for line ending characters 3 months ago
briar.py Prepare for alternative value field within attachments 5 months ago
cache.py Alternatives to #main-key 1 month ago
caddy.example.conf Update example caddy file 5 months ago
categories.py Explicitly set file encoding 4 months ago
city.py Function for line ending characters 3 months ago
code-of-conduct.md Add anti-trade union as a discrimination category 9 months ago
content.py Full url for mentions 4 weeks ago
context.py Extra schema 6 months ago
conversation.py Function for finding text in file 4 months ago
crawlers.py Function for line ending characters 3 months ago
cwtch.py Tidying 4 months ago
daemon.py Tidying 2 weeks ago
default_about.md Default about 9 months ago
default_dogwhistles.txt Compare lower case 3 months ago
default_tos.md Larger likes count on mobile 7 months ago
defaultthemes.txt Don't overwrite default themes during import 1 year ago
delete.py Tidying 4 months ago
desktop_client.py Tiding 3 weeks ago
devices.py Version 1.3.0 8 months ago
donate.py Prepare for alternative value field within attachments 5 months ago
enigma.py Tidying 4 months ago
epicyon-blog.css Revert "Set content visibility" 2 months ago
epicyon-calendar.css Change default place color 4 months ago
epicyon-follow.css Don't wrap whitespace 5 months ago
epicyon-graph.css Zero 11 months ago
epicyon-links.css Revert "Set content visibility" 2 months ago
epicyon-login.css Tiny login screen 10 months ago
epicyon-options.css Add banner to person options screen 4 months ago
epicyon-podcast.css Styling for performer images on podcast screen 5 months ago
epicyon-profile.css Revert "Set content visibility" 2 months ago
epicyon-search.css Checkbox sizes on mobile 7 months ago
epicyon-suspended.css Crisp rendering on pixel theme 2 years ago
epicyon-welcome.css Tiny welcome screen 10 months ago
epicyon.py By default don't archive media 1 month ago
feeds.py Tidying 4 months ago
filters.py Emojis representing twitter link 2 months ago
fitnessFunctions.py Page number icons 3 months ago
follow.py Tidying 3 weeks ago
followingCalendar.py Ability to minimize images shown from followed accounts 4 months ago
git.py Replacing open statements 4 months ago
happening.py Function for line ending characters 3 months ago
hashtagrules.txt From operator in hashtag rules 2 years ago
httpsig.py Tidying 4 months ago
i2pdomain Change domain to libreserver.org 1 year ago
importFollowing.py Function to start threads 2 months ago
inbox.py Fix hashtag indexing bug 1 month ago
install-desktop-client Support for mimic3 tts 3 months ago
languages.py Tidying 4 months ago
like.py Tidying 4 months ago
linked_data_sig.py Tidying 4 months ago
locations.txt City size 5 months ago
locations_nogo.txt Extra nogo area 1 year ago
manualapprove.py Function to start threads 2 months ago
maps.py Tidying 1 month ago
markdown.py Extra heading 3 months ago
mastoapiv1.py Response to mastodon streaming requests 7 months ago
matrix.py Prepare for alternative value field within attachments 5 months ago
media.py Check that strings passed to system commands are safe 2 months ago
metadata.py Explicitly set file encoding 4 months ago
migrate.py Explicitly set file encoding 4 months ago
newsdaemon.py Function to start threads 2 months ago
newswire.py Function for line ending characters 3 months ago
notifyOnPost.py Replacing open statements 4 months ago
outbox.py Store hashtags on post 1 month ago
person.py Tidying 3 weeks ago
petnames.py Explicitly set file encoding 4 months ago
pgp.py Check that strings passed to system commands are safe 2 months ago
posts.py Fix hashtag indexing bug 1 month ago
principlesofunity.md Convert to markdown 10 months ago
pyjsonld.py Begin support for ipfs 5 months ago
pyproject.toml Add setuptools package files 2 years ago
qrcode.py Tidying 6 months ago
question.py Tidying 4 months ago
reaction.py Function for line ending characters 3 months ago
roles.py Handle removing all roles 4 weeks ago
sbom.json Update bom 1 month ago
schedule.py Function to start threads 2 months ago
security_audit Security audit script 2 years ago
session.py Tidying 4 months ago
setup.cfg Change domain to libreserver.org 1 year ago
setup.py Add stub setup.py 2 years ago
shares.py Additional checking of digit string lengths 3 weeks ago
siteactive.py Debug 4 months ago
skills.py Handle none return valued from nickname 6 months ago
socnet.py Tidying 4 months ago
speaker.py Tidying 4 months ago
ssb.py Prepare for alternative value field within attachments 5 months ago
static_analysis Fix unit test 8 months ago
tests.py Not quiet 3 weeks ago
theme.py Debug 1 month ago
threads.py Function to start threads 2 months ago
tox.py Prepare for alternative value field within attachments 5 months ago
utils.py Tidying 2 weeks ago
video.py Use contentMap 6 months ago
webapp_about.py Remove old css cache 3 months ago
webapp_accesskeys.py Remove old css cache 3 months ago
webapp_calendar.py Additional checking of digit string lengths 3 weeks ago
webapp_column_left.py Remove old css cache 3 months ago
webapp_column_right.py Remove old css cache 3 months ago
webapp_confirm.py Add confirmation screen for person options block button 3 months ago
webapp_create_post.py Remove old css cache 3 months ago
webapp_frontscreen.py Remove unused argument 3 weeks ago
webapp_hashtagswarm.py txt extension 1 month ago
webapp_headerbuttons.py Remove show/hide button for text mode browsers 3 months ago
webapp_likers.py Translate the nowplaying hashtag 2 months ago
webapp_login.py Username might not be at the start 1 month ago
webapp_media.py Check that media url is not just the site domain name 4 weeks ago
webapp_minimalbutton.py Explicitly set file encoding 4 months ago
webapp_moderation.py Don't show left and right timeline columns in text-mode browser 3 months ago
webapp_person_options.py Change the position of the block button 3 months ago
webapp_podcast.py Remove old css cache 3 months ago
webapp_post.py Create hashtag lookups for map links 1 month ago
webapp_profile.py Option to enable spam filtering of actors 3 weeks ago
webapp_question.py Replacing open statements 4 months ago
webapp_search.py Banner on shared items search screen 4 weeks ago
webapp_specification.py Remove old css cache 3 months ago
webapp_suspended.py Remove old css cache 3 months ago
webapp_theme_designer.py Remove old css cache 3 months ago
webapp_timeline.py Extra newlines on text mode login screen 1 month ago
webapp_tos.py Explicitly set file encoding 4 months ago
webapp_utils.py Less subtitle markup 4 weeks ago
webapp_welcome.py Explicitly set file encoding 4 months ago
webapp_welcome_final.py Explicitly set file encoding 4 months ago
webapp_welcome_profile.py Explicitly set file encoding 4 months ago
webfinger.py Declare variable 3 months ago
xmpp.py Prepare for alternative value field within attachments 5 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 fediverse server suitable for self-hosting a small number of accounts on low power systems.

Key features:

  • Open standards: HTML, CSS, ActivityPub, RSS, CalDAV.
  • Supports common web browsers and shell browsers.
  • Will not drain your mobile or laptop battery.
  • Customisable themes. It doesn't have to look bland.
  • Emoji reactions.
  • Geospatial hashtags.
  • Does not require much RAM, either on server or client.
  • Suitable for installation on single board computers.
  • No timeline algorithms.
  • No javascript.
  • No database. Data stored as ordinary files.
  • No fashionable web frameworks. "Boring by design".
  • No blockchain garbage.
  • Written in Python, with few dependencies.
  • AGPL license, which big tech hates.

Epicyon is for people who are tired of big anything and just want to DIY their online social experience without much fuss or expense. Think water cooler discussions rather than shouting into the void, in which you're mainly just reading and responding to the posts of people that you're following.

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

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.

Clone the repo, or if you downloaded the tarball then extract it into the /opt directory.

cd /opt
git clone https://gitlab.com/bashrc2/epicyon

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 --log_login_failures
Environment=USER=epicyon
Environment=PYTHONUNBUFFERED=true
Restart=always
StandardError=syslog
CPUQuota=80%
ProtectHome=true
ProtectKernelTunables=true
ProtectKernelModules=true
ProtectControlGroups=true
ProtectKernelLogs=true
ProtectHostname=true
ProtectClock=true
ProtectProc=invisible
ProcSubset=pid
PrivateTmp=true
PrivateUsers=true
PrivateDevices=true
PrivateIPC=true
MemoryDenyWriteExecute=true
NoNewPrivileges=true
LockPersonality=true
RestrictRealtime=true
RestrictSUIDSGID=true
RestrictNamespaces=true
SystemCallArchitectures=native

[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.

systemctl stop nginx
certbot certonly -n --server https://acme-v02.api.letsencrypt.org/directory --standalone -d YOUR_DOMAIN --renew-by-default --agree-tos --email YOUR_EMAIL
systemctl start nginx

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

Software Bill of Materials

To update the software bill of materials:

sudo pip3 install scanoss
make clean
make sbom