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.
 
 
 
 
Tim 131889c81c Add '.woodpecker.yml' 4 months ago
architecture Update architecture diagrams 7 months ago
cwlists Section for attached image 6 months ago
defaultcategories Update default hashtag categories 5 months ago
defaultwelcome Turkish welcome screens 5 months ago
deploy More secure systemd settings 4 months ago
emoji Extra emoji 4 months ago
fonts Update fonts 8 months ago
gemini/EN More secure systemd settings 4 months ago
img rc3 screenshot 10 months ago
ontology Publication ontology 1 year ago
scripts Script to show thread events 7 months ago
theme Font size for page number dash 4 months ago
translations Banner on calendar day screen 4 months ago
website/EN More secure systemd settings 4 months 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 Snake case 9 months ago
README.md More secure systemd settings 4 months ago
README_architecture.md Architecture notes 6 months ago
README_commandline.md Note about web crawlers 7 months ago
README_customizations.md Changes for theme creation 6 months ago
README_desktop_client.md Desktop client screenshot 10 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 Handle incoming edited posts 6 months ago
announce.py Snake case 4 months ago
auth.py Unit test for caldav report 7 months ago
availability.py Handle none return valued from nickname 6 months ago
blocking.py Use contentMap within cw list processing 6 months ago
blog.py Show svg images if they originate from the local domain 4 months ago
bookmarks.py Handle incoming edited posts 6 months ago
briar.py Prepare for alternative value field within attachments 5 months ago
cache.py Use correct user agent domain for public key lookups 4 months ago
caddy.example.conf Update example caddy file 5 months ago
categories.py Version 1.3.0 8 months ago
city.py Version 1.3.0 8 months ago
code-of-conduct.md Add anti-trade union as a discrimination category 9 months ago
content.py Tidying 4 months ago
context.py Extra schema 6 months ago
conversation.py Version 1.3.0 8 months ago
crawlers.py Improve user agent blocking 6 months ago
cwtch.py Prepare for alternative value field within attachments 5 months ago
daemon.py Missing argument 4 months ago
default_about.md Default about 9 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 Only prevent remote DM deletions during archive 5 months ago
desktop_client.py Set end time for events 4 months ago
devices.py Version 1.3.0 8 months ago
donate.py Prepare for alternative value field within attachments 5 months ago
enigma.py Prepare for alternative value field within attachments 5 months ago
epicyon-blog.css Reverse the reply icon 5 months ago
epicyon-calendar.css Banner style 4 months ago
epicyon-follow.css Don't wrap whitespace 5 months ago
epicyon-graph.css Zero 11 months ago
epicyon-links.css Reverse the reply icon 5 months ago
epicyon-login.css Tiny login screen 10 months ago
epicyon-options.css Checkbox sizes on mobile 7 months ago
epicyon-podcast.css Styling for performer images on podcast screen 5 months ago
epicyon-profile.css Font size for page number dash 4 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 Set end time for events 4 months ago
feeds.py Version 1.3.0 8 months ago
filters.py Version 1.3.0 8 months ago
fitnessFunctions.py Sort with more preceding zeros 5 months ago
follow.py Begin support for ipfs 5 months ago
followingCalendar.py Version 1.3.0 8 months ago
git.py Handle incoming edited posts 6 months ago
happening.py Supplying extra user agent parameters 4 months ago
hashtagrules.txt From operator in hashtag rules 2 years ago
httpsig.py Revert "Try sending json with activity and ld accept" 7 months ago
i2pdomain Change domain to libreserver.org 1 year ago
inbox.py Use correct user agent domain for public key lookups 4 months ago
install-desktop-client Stream 2 years ago
languages.py Prepare for alternative property names 5 months ago
like.py Handle incoming edited posts 6 months ago
linked_data_sig.py Include a nonce within Json-LD signatures 5 months ago
locations.txt City size 5 months ago
locations_nogo.txt Extra nogo area 1 year ago
manualapprove.py Check that original domain is not onion or i2p 7 months ago
maps.py Map dimensions 4 months ago
markdown.py Version 1.3.0 8 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 Convert music genre numbers into text 4 months ago
metadata.py Support opus audio format 5 months ago
migrate.py Begin support for ipfs 5 months ago
newsdaemon.py Wait longer between rss feed updates 5 months ago
newswire.py Include chapters on podcast screen 5 months ago
notifyOnPost.py Version 1.3.0 8 months ago
outbox.py Save ssml to outbox 5 months ago
person.py Generalize attachment properties on actors 5 months ago
petnames.py Version 1.3.0 8 months ago
pgp.py Supporting alternative name and value properties in attachments 5 months ago
posts.py Set the user agent domain 4 months 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 Version 1.3.0 8 months ago
reaction.py Maintain a list of common emoji reactions 5 months ago
roles.py Version 1.3.0 8 months ago
schedule.py Debug for thread events 7 months ago
security_audit Security audit script 2 years ago
session.py Explicitly set user agent parameters 4 months ago
setup.cfg Change domain to libreserver.org 1 year ago
setup.py Add stub setup.py 2 years ago
shares.py Handle incoming edited posts 6 months ago
siteactive.py Begin support for ipfs 5 months ago
skills.py Handle none return valued from nickname 6 months ago
socnet.py Version 1.3.0 8 months ago
speaker.py Show summary within ssml 5 months ago
ssb.py Prepare for alternative value field within attachments 5 months ago
static_analysis Fix unit test 8 months ago
tests.py Unit test for cacheing svg images 4 months ago
theme.py Setting default theme from json 6 months ago
threads.py Debug for thread events 7 months ago
tox.py Prepare for alternative value field within attachments 5 months ago
utils.py Hashtags cannot be numbers 4 months ago
video.py Use contentMap 6 months ago
webapp_about.py Version 1.3.0 8 months ago
webapp_accesskeys.py Submit becomes Publish 4 months ago
webapp_calendar.py Extra line after banner 4 months ago
webapp_column_left.py Focus for column buttons 4 months ago
webapp_column_right.py New blog access key 4 months ago
webapp_confirm.py async image loading 6 months ago
webapp_create_post.py Supplying extra user agent parameters 4 months ago
webapp_frontscreen.py No tab order to columns 4 months ago
webapp_hashtagswarm.py async image loading 6 months ago
webapp_headerbuttons.py Button tab indexes 4 months ago
webapp_likers.py async image loading 6 months ago
webapp_login.py async image loading 6 months ago
webapp_media.py Tab index for media embeds 4 months ago
webapp_minimalbutton.py Version 1.3.0 8 months ago
webapp_moderation.py async image loading 6 months ago
webapp_person_options.py Submit becomes Publish 4 months ago
webapp_podcast.py Styling for performer images on podcast screen 5 months ago
webapp_post.py Use default avatar 4 months ago
webapp_profile.py Link class 4 months ago
webapp_question.py Version 1.3.0 8 months ago
webapp_search.py Submit becomes Publish 4 months ago
webapp_suspended.py Version 1.3.0 8 months ago
webapp_theme_designer.py Submit becomes Publish 4 months ago
webapp_timeline.py Extra line at end of page 4 months ago
webapp_tos.py Version 1.3.0 8 months ago
webapp_utils.py Show svg images if they originate from the local domain 4 months ago
webapp_welcome.py Version 1.3.0 8 months ago
webapp_welcome_final.py Version 1.3.0 8 months ago
webapp_welcome_profile.py Version 1.3.0 8 months ago
webfinger.py String cast 4 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 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