Modern ActivityPub compliant server, designed for simplicity and accessibility. Includes calendar and sharing economy features to empower your federated community. https://code.freedombone.net/bashrc/epicyon Docs: https://epicyon.net/#install
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 1ebb8a5d66 Website metadata 9 ore fa
defaultcategories Update default categories 1 settimana fa
defaultwelcome Rite of passage 1 settimana fa
deploy Remove unused package from documentation 3 mesi fa
emoji freebsd emoji 3 giorni fa
fonts Add pixel font 2 mesi fa
gemini/EN Remove unused package from documentation 3 mesi fa
img lynx screenshot 3 mesi fa
orgs Comma 1 anno fa
scripts Notification flags on speaker endpoint 2 mesi fa
theme Reply background 1 settimana fa
translations Occupation on edit profile screen 2 giorni fa
website/EN Website metadata 9 ore fa
.datignore Ignore file for dat 1 anno fa
.gitignore Ignore package install files 3 mesi fa
.gitlab-ci.yml Update cryptography dependency for CI 2 mesi fa
CONTRIBUTING.md Contributing file 1 anno fa
CONTRIBUTORS.md Add contributors list 1 anno fa
Dockerfile Using python3-cryptography 3 mesi fa
LICENSE Initial 1 anno fa
Makefile Custom help text for indymedia themes 2 mesi fa
README.md Typos in various README files fixed 1 mese fa
README_commandline.md Remove role delegation 1 giorno fa
README_customizations.md Typos in various README files fixed 1 mese fa
README_desktop_client.md Separate readme for desktop client 1 settimana fa
README_goals.md Typos in various README files fixed 1 mese fa
README_roadmap.md Roadmap 8 mesi fa
__init__.py Use package directory to namespace modules 3 mesi fa
acceptreject.py Join activity has the same meaning as Follow 3 mesi fa
announce.py Remove original announce post when unannouncing 6 giorni fa
auth.py Version 1.2.0 3 mesi fa
availability.py Improve c2s debug messages 1 mese fa
blocking.py NodeInfo metadata is unavailable during broch mode 1 settimana fa
blog.py Include news account 3 settimane fa
bookmarks.py Refresh timeline after mute 1 mese fa
briar.py Version 1.2.0 3 mesi fa
cache.py Check if actor has changed 2 mesi fa
caddy.example.conf Caddy web server configuration 1 anno fa
categories.py More hashtag checks 3 mesi fa
city.py Fix unit tests 1 giorno fa
code-of-conduct.md Update code of conduct 3 settimane fa
content.py Another long lines failure case 1 mese fa
context.py Litepub social context 3 mesi fa
daemon.py Include metadata on about screen 9 ore fa
default_about.md Default about text 2 mesi fa
default_tos.md Remove lines 2 mesi fa
delete.py Delete posts via desktop client 1 mese fa
desktop_client.py Default geolocation 5 giorni fa
devices.py Version 1.2.0 3 mesi fa
donate.py Version 1.2.0 3 mesi fa
epicyon-blog.css Option to have round avatars 1 settimana fa
epicyon-calendar.css Calendar item styles for public or private 2 mesi fa
epicyon-follow.css Crisp rendering on pixel theme 2 mesi fa
epicyon-links.css Option to have round avatars 1 settimana fa
epicyon-login.css Crisp rendering on pixel theme 2 mesi fa
epicyon-options.css Rounded avatar on options screen 1 settimana fa
epicyon-profile.css Option to have round avatars 1 settimana fa
epicyon-search.css Crisp rendering on pixel theme 2 mesi fa
epicyon-suspended.css Crisp rendering on pixel theme 2 mesi fa
epicyon-welcome.css Markdown image style 2 mesi fa
epicyon.py Remove role delegation 1 giorno fa
feeds.py Version 1.2.0 3 mesi fa
filters.py Version 1.2.0 3 mesi fa
follow.py Tidying 1 mese fa
followingCalendar.py Version 1.2.0 3 mesi fa
git.py Version 1.2.0 3 mesi fa
happening.py Private calendar events have a different background color 2 mesi fa
hashtagrules.txt From operator in hashtag rules 6 mesi fa
httpsig.py Fix new http signature test 1 mese fa
i2pdomain i2p domain utility 11 mesi fa
inbox.py Default geolocation 5 giorni fa
install-desktop-client Stream 1 mese fa
jami.py Version 1.2.0 3 mesi fa
like.py Smaller timeouts 1 mese fa
linked_data_sig.py Move jsonld signatures to python3-cryptography 3 mesi fa
locations.txt City locations 4 giorni fa
manualapprove.py Honk style users path 3 mesi fa
mastoapiv1.py Version 1.2.0 3 mesi fa
matrix.py Version 1.2.0 3 mesi fa
media.py Add camera properties 3 giorni fa
metadata.py Tidying 1 settimana fa
migrate.py Less verbose 2 mesi fa
newsdaemon.py Default geolocation 5 giorni fa
newswire.py Less verbose 2 mesi fa
outbox.py Remove role delegation 1 giorno fa
person.py Comments 1 giorno fa
petnames.py Version 1.2.0 3 mesi fa
pgp.py Get pgp public key when default keyid is unavailable 1 settimana fa
posts.py Spoof gps metadata on images 5 giorni fa
principlesofunity.txt Remove brackets 6 mesi fa
pyjsonld.py Handle exception in jsonld signature check 2 mesi fa
pyproject.toml Add setuptools package files 3 mesi fa
question.py Version 1.2.0 3 mesi fa
roles.py Fix unit tests 1 giorno fa
schedule.py Spoof gps metadata on images 5 giorni fa
security_audit Security audit script 10 mesi fa
session.py Refresh timeline after mute 1 mese fa
setup.cfg Pypi: bump minor version for crypto changes 3 mesi fa
setup.py Add stub setup.py 2 mesi fa
shares.py Add city model 4 giorni fa
siteactive.py Improve checking of site active status 3 mesi fa
skills.py Unit tests for skills functions 1 giorno fa
socnet.py Less verbose when not in debug 2 mesi fa
speaker.py Fix speakable return values 1 mese fa
ssb.py Version 1.2.0 3 mesi fa
static_analysis Tidying 1 mese fa
tests.py Remove role delegation 1 giorno fa
theme.py Include news account 3 settimane fa
threads.py Version 1.2.0 3 mesi fa
tox.py Version 1.2.0 3 mesi fa
utils.py Tidying 1 settimana fa
webapp_about.py Include metadata on about screen 9 ore fa
webapp_accesskeys.py Help text on key shortcuts screen 3 settimane fa
webapp_calendar.py Key shortcuts on calendar screen 3 settimane fa
webapp_column_left.py Key shortcuts on edit links screen 3 settimane fa
webapp_column_right.py Key shortcuts on edit newswire screen 3 settimane fa
webapp_confirm.py Revert "Key access to individual timeline posts" 3 settimane fa
webapp_create_post.py Key shortcuts for new post dropdown 3 settimane fa
webapp_frontscreen.py Key shortcuts for newswire 3 settimane fa
webapp_hashtagswarm.py Validation of categories 3 mesi fa
webapp_headerbuttons.py Key shortcut to media timeline 3 settimane fa
webapp_login.py Accessibility metadata on login screen 10 ore fa
webapp_media.py Video style 2 mesi fa
webapp_moderation.py Setting keyboard shortcuts for timeline 3 settimane fa
webapp_person_options.py More key shortcuts 3 settimane fa
webapp_post.py Remove id ending from announce 6 giorni fa
webapp_profile.py Remove role delegation 1 giorno fa
webapp_question.py Version 1.2.0 3 mesi fa
webapp_search.py More standards compliant representation of skills 1 giorno fa
webapp_suspended.py Version 1.2.0 3 mesi fa
webapp_timeline.py At least one post for page down 2 settimane fa
webapp_tos.py Terms of service in markdown format 2 mesi fa
webapp_utils.py Add website url 9 ore fa
webapp_welcome.py Allow theme specific welcome files 2 mesi fa
webapp_welcome_final.py Allow theme specific welcome files 2 mesi fa
webapp_welcome_profile.py Set default bio 3 settimane fa
webfinger.py Less verbose 2 mesi fa
xmpp.py Version 1.2.0 3 mesi fa

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.

Project Goals - Commandline interface - Customizations - Code of Conduct

Matrix room: #epicyon:matrix.freedombone.net

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
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;

    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_session_cache  builtin:1000  shared:SSL:10m;
    ssl_session_timeout 60m;
    ssl_prefer_server_ciphers on;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS';
    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 X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";
    add_header Strict-Transport-Security max-age=15768000;

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

    index index.html;

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

    location / {
        proxy_http_version 1.1;
        client_max_body_size 31M;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        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 on;
        proxy_buffering on;
        proxy_pass http://localhost:7156;
    }
}

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