Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar, news and sharing economy features to empower your federated community. We spent a year testing this for a hyper local indymedia codebase.
 
 
 
 
 
Go to file
Bob Mottram a6a54607c1 Skip blanks 2022-11-23 19:00:59 +00:00
architecture Regenerate architecture diagrams 2022-11-21 14:09:51 +00:00
cwlists Add spaces 2022-07-18 14:09:15 +01:00
defaultcategories Update default categories 2022-11-13 21:44:35 +00:00
defaultwelcome Start of Bengali language 2022-06-06 13:14:04 +01:00
deploy Tidying 2022-08-10 12:12:28 +01:00
emoji More emojis 2022-11-14 15:43:08 +00:00
fonts Add an extra font 2022-11-12 11:57:42 +00:00
gemini/EN Regenerate manual 2022-11-21 13:56:27 +00:00
img Change logo 2022-07-24 19:25:34 +01:00
manual Remove lines 2022-11-23 18:54:39 +00:00
ontology Language support for clothing types 2022-06-06 23:24:38 +01:00
scripts Add comma 2022-11-13 13:07:00 +00:00
specification Specification image width 2022-10-23 22:07:54 +01:00
theme Style for block reasons 2022-11-23 15:31:29 +00:00
translations Update translations/ko.json 2022-11-18 13:11:46 +00:00
website/EN Regenerate manual 2022-11-21 13:56:27 +00:00
.datignore
.gitignore
.gitlab-ci.yml
.woodpecker.yml Add file for woodpecker CI 2022-09-14 18:47:03 +01:00
CONTRIBUTING.md
CONTRIBUTORS.md
Dockerfile
LICENSE
Makefile Clean cwlists 2022-06-05 17:31:51 +01:00
README.md Regenerate manual 2022-11-21 13:56:27 +00:00
README_architecture.md Architecture notes 2022-04-12 11:17:23 +01:00
README_coding_style.md Python version 2022-06-14 10:30:31 +01:00
README_commandline.md More explanation 2022-08-29 15:04:50 +01:00
README_customizations.md Emoji import 2022-11-07 16:38:43 +00:00
README_desktop_client.md Support for mimic3 tts 2022-06-29 23:00:24 +01:00
README_goals.md Add NFTs as not being a goal 2022-04-28 16:09:06 +01:00
README_roadmap.md
__init__.py
acceptreject.py Replace open with text in file function 2022-06-10 14:29:51 +01:00
announce.py Tidying 2022-06-09 17:05:42 +01:00
auth.py Function for line ending characters 2022-06-21 12:58:50 +01:00
availability.py Handle none return valued from nickname 2022-03-23 23:59:29 +00:00
blocking.py Skip blanks 2022-11-23 19:00:59 +00:00
blog.py Additional timeline steadying 2022-11-20 18:09:30 +00:00
bookmarks.py Function for line ending characters 2022-06-21 12:58:50 +01:00
briar.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
cache.py Alternatives to #main-key 2022-08-27 20:15:58 +01:00
caddy.example.conf Update example caddy file 2022-05-03 19:17:23 +01:00
categories.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
city.py Function for line ending characters 2022-06-21 12:58:50 +01:00
code-of-conduct.md
content.py Use hidden 2022-11-11 11:40:43 +00:00
context.py Extra schema 2022-04-03 20:53:48 +01:00
conversation.py Function for finding text in file 2022-06-10 12:43:33 +01:00
crawlers.py Block scanner 2022-11-06 09:56:42 +00:00
cwtch.py Tidying 2022-05-30 22:41:18 +01:00
daemon.py Adding account level blocks with reasons 2022-11-23 18:14:46 +00:00
default_about.md
default_dogwhistles.txt Compare lower case 2022-07-05 19:47:23 +01:00
default_tos.md Larger likes count on mobile 2022-03-01 17:28:27 +00:00
defaultthemes.txt
delete.py Tidying 2022-05-30 22:41:18 +01:00
desktop_client.py Tiding 2022-09-08 19:23:21 +01:00
devices.py Version 1.3.0 2022-02-03 13:58:20 +00:00
donate.py Tidying 2022-11-04 21:13:07 +00:00
enigma.py Tidying 2022-05-30 22:41:18 +01:00
epicyon-blog.css Highlight json links 2022-09-29 11:47:35 +01:00
epicyon-calendar.css Change default place color 2022-06-16 11:43:03 +01:00
epicyon-follow.css Don't wrap whitespace 2022-04-19 11:12:08 +01:00
epicyon-graph.css
epicyon-links.css Highlight json links 2022-09-29 11:47:35 +01:00
epicyon-login.css
epicyon-options.css Add banner to person options screen 2022-06-03 21:45:56 +01:00
epicyon-podcast.css Highlight json links 2022-09-29 11:47:35 +01:00
epicyon-profile.css Style for block reasons 2022-11-23 15:31:29 +00:00
epicyon-search.css Checkbox sizes on mobile 2022-03-03 12:50:04 +00:00
epicyon-suspended.css
epicyon-welcome.css
epicyon.py Expire cached announces 2022-11-22 10:51:08 +00:00
feeds.py Tidying 2022-05-30 22:41:18 +01:00
filters.py Remove square capitals when filtering 2022-10-05 18:55:24 +01:00
fitnessFunctions.py Avoid None returned when loading fitness file 2022-09-24 17:33:23 +01:00
follow.py Tidying 2022-09-10 10:24:13 +01:00
followingCalendar.py Ability to minimize images shown from followed accounts 2022-06-11 17:14:16 +01:00
git.py Replacing open statements 2022-06-10 14:01:39 +01:00
happening.py Check for inverted text 2022-09-25 18:26:11 +01:00
hashtagrules.txt
httpsig.py Tidying 2022-05-30 22:41:18 +01:00
i2pdomain
importFollowing.py Notes is the last csv field 2022-11-22 09:47:54 +00:00
inbox.py Set maximum number of hashtags 2022-11-19 18:03:55 +00:00
install-desktop-client Support for mimic3 tts 2022-06-29 23:00:24 +01:00
languages.py Tidying 2022-06-14 11:51:40 +01:00
like.py Tidying 2022-06-14 11:51:40 +01:00
linked_data_sig.py Tidying 2022-05-30 19:33:51 +01:00
locations.txt City size 2022-05-09 13:10:41 +01:00
locations_nogo.txt
manualapprove.py Function to start threads 2022-07-28 10:59:18 +01:00
maps.py Tidying 2022-09-30 22:31:36 +01:00
markdown.py Fix markdown test 2022-11-10 09:52:38 +00:00
mastoapiv1.py Response to mastodon streaming requests 2022-02-25 10:29:14 +00:00
matrix.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
media.py Support wave file attachments 2022-10-31 11:05:11 +00:00
metadata.py Outbound services 2022-11-08 11:25:32 +00:00
migrate.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
newsdaemon.py Function to start threads 2022-07-28 10:59:18 +01:00
newswire.py Support heic formatted images 2022-10-31 17:26:31 +00:00
notifyOnPost.py Replacing open statements 2022-06-10 14:01:39 +01:00
outbox.py Sending updates via outbox 2022-11-17 20:10:30 +00:00
person.py Additional timeline steadying 2022-11-20 18:09:30 +00:00
petnames.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
pgp.py Check that strings passed to system commands are safe 2022-07-22 11:54:57 +01:00
posts.py Less verbose 2022-11-22 11:09:24 +00:00
principlesofunity.md
pyjsonld.py Fix warnings 2022-09-21 21:17:21 +01:00
pyproject.toml
qrcode.py Tidying 2022-04-04 10:29:54 +01:00
question.py Tidying 2022-06-14 11:51:40 +01:00
reaction.py Function for line ending characters 2022-06-21 12:58:50 +01:00
roles.py Handle removing all roles 2022-09-02 19:44:29 +01:00
sbom.json Update sbom 2022-11-08 16:58:34 +00:00
schedule.py Ability to minimize all images by default 2022-11-13 18:54:11 +00:00
security_audit
session.py Check that there are not too many rel="me" links 2022-11-10 09:46:48 +00:00
setup.cfg
setup.py
shares.py Check for inverted text 2022-09-25 18:26:11 +01:00
siteactive.py Debug 2022-06-06 12:21:25 +01:00
skills.py Handle none return valued from nickname 2022-03-23 23:59:29 +00:00
socnet.py Tidying 2022-05-31 18:13:28 +01:00
speaker.py Tidying 2022-06-14 11:24:29 +01:00
ssb.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
static_analysis Fix unit test 2022-02-03 12:30:57 +00:00
tests.py Max hashtags option 2022-11-19 18:47:28 +00:00
theme.py Debug 2022-08-29 10:48:39 +01:00
threads.py Function to start threads 2022-07-28 10:59:18 +01:00
tox.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
utils.py Over-zealous markup check 2022-11-21 12:54:58 +00:00
video.py Check for inverted text 2022-09-25 18:26:11 +01:00
webapp_about.py Remove old css cache 2022-07-12 20:03:30 +01:00
webapp_accesskeys.py Remove old css cache 2022-07-12 20:03:30 +01:00
webapp_calendar.py Additional checking of digit string lengths 2022-09-08 11:34:12 +01:00
webapp_column_left.py Link to user manual within left column 2022-10-10 10:25:46 +01:00
webapp_column_right.py Support heic formatted images 2022-10-31 17:26:31 +00:00
webapp_confirm.py Ability to minimize all images by default 2022-11-13 18:54:11 +00:00
webapp_create_post.py Set published and updated dates on edited posts 2022-11-16 14:51:57 +00:00
webapp_frontscreen.py Ability to minimize all images by default 2022-11-13 18:54:11 +00:00
webapp_hashtagswarm.py txt extension 2022-08-23 21:24:21 +01:00
webapp_headerbuttons.py Remove show/hide button for text mode browsers 2022-07-13 14:16:54 +01:00
webapp_likers.py Ability to minimize all images by default 2022-11-13 18:54:11 +00:00
webapp_login.py Support heic formatted images 2022-10-31 17:26:31 +00:00
webapp_manual.py Link to user manual within left column 2022-10-10 10:25:46 +01:00
webapp_media.py Check that video site has a path 2022-11-07 11:15:08 +00:00
webapp_minimalbutton.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
webapp_moderation.py Adding reasons to account level blocks 2022-11-23 18:40:45 +00:00
webapp_person_options.py Update announces allowed 2022-11-08 15:43:26 +00:00
webapp_podcast.py Support wave file attachments 2022-10-31 11:05:11 +00:00
webapp_post.py Don't need backslashes 2022-11-20 13:37:55 +00:00
webapp_profile.py Adding reasons to account level blocks 2022-11-23 18:40:45 +00:00
webapp_question.py Replacing open statements 2022-06-10 14:01:39 +01:00
webapp_search.py Ability to minimize all images by default 2022-11-13 18:54:11 +00:00
webapp_specification.py Remove old css cache 2022-07-12 20:03:30 +01:00
webapp_suspended.py Remove old css cache 2022-07-12 20:03:30 +01:00
webapp_theme_designer.py Remove old css cache 2022-07-12 20:03:30 +01:00
webapp_timeline.py Safer path 2022-11-20 16:28:46 +00:00
webapp_tos.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
webapp_utils.py More export fields 2022-11-22 09:43:29 +00:00
webapp_welcome.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
webapp_welcome_final.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
webapp_welcome_profile.py Explicitly set file encoding 2022-06-09 15:46:30 +01:00
webfinger.py Declare variable 2022-06-21 09:31:11 +01:00
xmpp.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00

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.

User Manual - 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 http2;
    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