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 f021c3658a Aria current page 2022-05-29 10:05:01 +01:00
architecture Update architecture diagrams 2022-03-05 10:04:07 +00:00
cwlists Section for attached image 2022-04-15 13:56:30 +01:00
defaultcategories Update default hashtag categories 2022-04-28 13:45:44 +01:00
defaultwelcome Turkish welcome screens 2022-05-09 10:59:36 +01:00
deploy More secure systemd settings 2022-05-19 19:21:19 +01:00
emoji Extra emoji 2022-05-24 17:06:34 +01:00
fonts
gemini/EN More secure systemd settings 2022-05-19 19:21:19 +01:00
img
ontology
scripts Script to show thread events 2022-03-13 11:03:26 +00:00
theme Event background 2022-05-23 13:40:26 +01:00
translations Translations for new blog post 2022-05-25 20:41:04 +01:00
website/EN More secure systemd settings 2022-05-19 19:21:19 +01:00
.datignore
.gitignore
.gitlab-ci.yml
CONTRIBUTING.md
CONTRIBUTORS.md
Dockerfile
LICENSE
Makefile
README.md More secure systemd settings 2022-05-19 19:21:19 +01:00
README_architecture.md Architecture notes 2022-04-12 11:17:23 +01:00
README_commandline.md Note about web crawlers 2022-03-06 13:07:25 +00:00
README_customizations.md Changes for theme creation 2022-04-12 10:56:06 +01:00
README_desktop_client.md
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 Handle incoming edited posts 2022-04-09 16:11:22 +01:00
announce.py Snake case 2022-05-26 23:52:32 +01:00
auth.py Unit test for caldav report 2022-02-24 16:55:37 +00:00
availability.py Handle none return valued from nickname 2022-03-23 23:59:29 +00:00
blocking.py Use contentMap within cw list processing 2022-04-13 15:35:11 +01:00
blog.py Show svg images if they originate from the local domain 2022-05-26 12:11:53 +01:00
bookmarks.py Handle incoming edited posts 2022-04-09 16:11:22 +01:00
briar.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
cache.py Use correct user agent domain for public key lookups 2022-05-27 10:20:37 +01:00
caddy.example.conf Update example caddy file 2022-05-03 19:17:23 +01:00
categories.py Version 1.3.0 2022-02-03 13:58:20 +00:00
city.py Version 1.3.0 2022-02-03 13:58:20 +00:00
code-of-conduct.md
content.py Tidying 2022-05-26 18:51:38 +01:00
context.py Extra schema 2022-04-03 20:53:48 +01:00
conversation.py Version 1.3.0 2022-02-03 13:58:20 +00:00
crawlers.py Improve user agent blocking 2022-03-31 17:14:19 +01:00
cwtch.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
daemon.py Distinguish between new post and new blog buttons 2022-05-25 20:27:44 +01:00
default_about.md
default_tos.md Larger likes count on mobile 2022-03-01 17:28:27 +00:00
defaultthemes.txt
delete.py Only prevent remote DM deletions during archive 2022-05-01 18:14:29 +01:00
desktop_client.py Set end time for events 2022-05-23 13:14:36 +01:00
devices.py Version 1.3.0 2022-02-03 13:58:20 +00:00
donate.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
enigma.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
epicyon-blog.css Reverse the reply icon 2022-05-07 13:41:03 +01:00
epicyon-calendar.css Calendar header style 2022-05-25 19:00:33 +01:00
epicyon-follow.css Don't wrap whitespace 2022-04-19 11:12:08 +01:00
epicyon-graph.css
epicyon-links.css Reverse the reply icon 2022-05-07 13:41:03 +01:00
epicyon-login.css
epicyon-options.css Checkbox sizes on mobile 2022-03-03 12:50:04 +00:00
epicyon-podcast.css Styling for performer images on podcast screen 2022-05-03 18:11:25 +01:00
epicyon-profile.css Revert "Remove duplicates" 2022-05-23 21:09:38 +01:00
epicyon-search.css Checkbox sizes on mobile 2022-03-03 12:50:04 +00:00
epicyon-suspended.css
epicyon-welcome.css
epicyon.py Set end time for events 2022-05-23 13:14:36 +01:00
feeds.py Version 1.3.0 2022-02-03 13:58:20 +00:00
filters.py Version 1.3.0 2022-02-03 13:58:20 +00:00
fitnessFunctions.py Sort with more preceding zeros 2022-04-23 20:47:40 +01:00
follow.py Begin support for ipfs 2022-04-29 14:54:13 +01:00
followingCalendar.py Version 1.3.0 2022-02-03 13:58:20 +00:00
git.py Handle incoming edited posts 2022-04-09 16:11:22 +01:00
happening.py Supplying extra user agent parameters 2022-05-26 22:58:22 +01:00
hashtagrules.txt
httpsig.py Revert "Try sending json with activity and ld accept" 2022-02-27 21:38:17 +00:00
i2pdomain
inbox.py Use correct user agent domain for public key lookups 2022-05-27 10:20:37 +01:00
install-desktop-client
languages.py Prepare for alternative property names 2022-05-11 17:10:38 +01:00
like.py Handle incoming edited posts 2022-04-09 16:11:22 +01:00
linked_data_sig.py Include a nonce within Json-LD signatures 2022-05-10 17:02:36 +01:00
locations.txt City size 2022-05-09 13:10:41 +01:00
locations_nogo.txt
manualapprove.py Check that original domain is not onion or i2p 2022-03-13 23:42:17 +00:00
maps.py Map dimensions 2022-05-23 14:36:15 +01:00
markdown.py Version 1.3.0 2022-02-03 13:58:20 +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 Convert music genre numbers into text 2022-05-20 18:01:12 +01:00
metadata.py Support opus audio format 2022-04-18 14:21:45 +01:00
migrate.py Begin support for ipfs 2022-04-29 14:54:13 +01:00
newsdaemon.py Wait longer between rss feed updates 2022-04-24 21:19:16 +01:00
newswire.py Include chapters on podcast screen 2022-05-03 17:38:16 +01:00
notifyOnPost.py Version 1.3.0 2022-02-03 13:58:20 +00:00
outbox.py Save ssml to outbox 2022-05-12 13:21:03 +01:00
person.py Generalize attachment properties on actors 2022-05-11 18:39:23 +01:00
petnames.py Version 1.3.0 2022-02-03 13:58:20 +00:00
pgp.py Supporting alternative name and value properties in attachments 2022-05-11 19:04:58 +01:00
posts.py Set the user agent domain 2022-05-27 11:00:23 +01:00
principlesofunity.md
pyjsonld.py Begin support for ipfs 2022-04-29 14:54:13 +01:00
pyproject.toml
qrcode.py Tidying 2022-04-04 10:29:54 +01:00
question.py Version 1.3.0 2022-02-03 13:58:20 +00:00
reaction.py Maintain a list of common emoji reactions 2022-04-18 21:49:53 +01:00
roles.py Version 1.3.0 2022-02-03 13:58:20 +00:00
schedule.py Debug for thread events 2022-03-13 11:01:07 +00:00
security_audit
session.py Explicitly set user agent parameters 2022-05-26 23:14:25 +01:00
setup.cfg
setup.py
shares.py Handle incoming edited posts 2022-04-09 16:11:22 +01:00
siteactive.py Begin support for ipfs 2022-04-29 14:54:13 +01:00
skills.py Handle none return valued from nickname 2022-03-23 23:59:29 +00:00
socnet.py Version 1.3.0 2022-02-03 13:58:20 +00:00
speaker.py Show summary within ssml 2022-05-12 18:41:40 +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 Unit test for cacheing svg images 2022-05-26 16:14:48 +01:00
theme.py Setting default theme from json 2022-04-05 12:29:06 +01:00
threads.py Debug for thread events 2022-03-13 11:01:07 +00:00
tox.py Prepare for alternative value field within attachments 2022-05-11 18:17:23 +01:00
utils.py Hashtags cannot be numbers 2022-05-20 11:17:53 +01:00
video.py Use contentMap 2022-04-13 17:32:17 +01:00
webapp_about.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_accesskeys.py Submit becomes Publish 2022-05-23 19:48:45 +01:00
webapp_calendar.py Center header 2022-05-25 19:09:57 +01:00
webapp_column_left.py Focus for column buttons 2022-05-25 13:12:45 +01:00
webapp_column_right.py New blog access key 2022-05-25 20:33:09 +01:00
webapp_confirm.py async image loading 2022-03-28 09:47:53 +01:00
webapp_create_post.py Supplying extra user agent parameters 2022-05-26 22:58:22 +01:00
webapp_frontscreen.py No tab order to columns 2022-05-25 11:17:44 +01:00
webapp_hashtagswarm.py async image loading 2022-03-28 09:47:53 +01:00
webapp_headerbuttons.py Button tab indexes 2022-05-25 11:58:43 +01:00
webapp_likers.py async image loading 2022-03-28 09:47:53 +01:00
webapp_login.py async image loading 2022-03-28 09:47:53 +01:00
webapp_media.py Tab index for media embeds 2022-05-25 14:38:17 +01:00
webapp_minimalbutton.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_moderation.py async image loading 2022-03-28 09:47:53 +01:00
webapp_person_options.py Submit becomes Publish 2022-05-23 19:48:45 +01:00
webapp_podcast.py Styling for performer images on podcast screen 2022-05-03 18:11:25 +01:00
webapp_post.py Use default avatar 2022-05-26 17:11:46 +01:00
webapp_profile.py Link class 2022-05-25 15:10:56 +01:00
webapp_question.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_search.py Submit becomes Publish 2022-05-23 19:48:45 +01:00
webapp_suspended.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_theme_designer.py Submit becomes Publish 2022-05-23 19:48:45 +01:00
webapp_timeline.py Aria current page 2022-05-29 10:05:01 +01:00
webapp_tos.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_utils.py Show svg images if they originate from the local domain 2022-05-26 12:11:53 +01:00
webapp_welcome.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_welcome_final.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webapp_welcome_profile.py Version 1.3.0 2022-02-03 13:58:20 +00:00
webfinger.py String cast 2022-05-28 18:01:43 +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 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
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.

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