Package: epicyon
Epicyon, meaning"more than a dog". Largest of theBorophaginaewhich lived in North America 20-5 million years ago.Epicyon is a modernActivityPubcompliant server implementing both S2S and C2S protocols and sutable 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 containsno javascriptand uses HTML+CSS with a Python backend.Project Goals-Commandline interface-Customizations-Code of ConductMatrix room:#epicyon:matrix.freedombone.netIncludes emojis designed byOpenMoji– 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 underApache 2.0.Digital Pets emojiwere made by Tomcat94 and licensed under CC0.Package DependenciesYou will need python version 3.7 or later.On Arch/Parabola:sudopacman-Storpython-pippython-pysockspython-cryptography\imagemagickpython-requests\perl-image-exiftoolpython-dateutil\certbotflake8bandit
sudopip3installpyqrcodepypngOr on Debian:sudoaptinstall-y\torpython3-socksimagemagick\python3-setuptools\python3-cryptography\python3-dateutil\python3-idnapython3-requests\python3-django-timezone-field\libimage-exiftool-perlpython3-flake8\python3-pyqrcodepython3-pngpython3-bandit\certbotnginxwgetInstallationIn 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/optdirectory. 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--groupepicyonLink news mirrors:mkdir/var/www/YOUR_DOMAIN
mkdir-p/opt/epicyon/accounts/newsmirror
ln-s/opt/epicyon/accounts/newsmirror/var/www/YOUR_DOMAIN/newsmirrorEdit/etc/systemd/system/epicyon.serviceand add the following:[Unit]Description=epicyonAfter=syslog.targetAfter=network.target[Service]Type=simpleUser=epicyonGroup=epicyonWorkingDirectory=/opt/epicyonExecStart=/usr/bin/python3 /opt/epicyon/epicyon.py --port 443 --proxy 7156 --domain YOUR_DOMAIN --registration openEnvironment=USER=epicyonEnvironment=PYTHONUNBUFFERED=trueRestart=alwaysStandardError=syslog[Install]WantedBy=multi-user.targetHere the server was installed to/opt/epicyon, but you can change that to wherever you installed it.Then run the daemon:systemctlenableepicyon
chown-Repicyon:epicyon/opt/epicyon
systemctlstartepicyonCheck the status of the daemon with:systemctlstatusepicyonIf it's not running then you can also look at the log:journalctl-uepicyonYou'll also need to set up a web server configuration. For Nginx edit/etc/nginx/sites-available/YOUR_DOMAINas follows:server{listen80;listen[::]:80;server_nameYOUR_DOMAIN;access_log/dev/null;error_log/dev/null;client_max_body_size31m;client_body_buffer_size128k;indexindex.html;rewrite^https://$server_name$request_uri?permanent;}server{listen443ssl;server_nameYOUR_DOMAIN;ssl_staplingoff;ssl_stapling_verifyoff;sslon;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_cachebuiltin:1000shared:SSL:10m;ssl_session_timeout60m;ssl_prefer_server_cipherson;ssl_protocolsTLSv1.2TLSv1.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_headerX-Frame-OptionsDENY;add_headerX-Content-Type-Optionsnosniff;add_headerX-XSS-Protection"1;mode=block";add_headerX-Download-Optionsnoopen;add_headerX-Permitted-Cross-Domain-Policiesnone;add_headerX-Robots-Tag"noindex,nofollow,nosnippet,noarchive";add_headerStrict-Transport-Securitymax-age=15768000;access_log/dev/null;error_log/dev/null;indexindex.html;location/newsmirror{root/var/www/YOUR_DOMAIN;try_files$uri=404;}location/{proxy_http_version1.1;client_max_body_size31M;proxy_set_headerUpgrade$http_upgrade;proxy_set_headerConnection"upgrade";proxy_set_headerHost$http_host;proxy_set_headerX-Real-IP$remote_addr;proxy_set_headerX-Forward-For$proxy_add_x_forwarded_for;proxy_set_headerX-Forward-Protohttp;proxy_set_headerX-Nginx-Proxytrue;proxy_temp_file_write_size64k;proxy_connect_timeout10080s;proxy_send_timeout10080;proxy_read_timeout10080;proxy_buffer_size64k;proxy_buffers1632k;proxy_busy_buffers_size64k;proxy_redirectoff;proxy_request_bufferingon;proxy_bufferingon;proxy_passhttp://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.certbotcertonly-n--serverhttps://acme-v02.api.letsencrypt.org/directory--standalone-dYOUR_DOMAIN--renew-by-default--agree-tos--emailYOUR_EMAILAnd restart the web server:systemctlrestartnginxIf you are using theCaddy web serverthen seecaddy.example.confRunning Static AnalysisStatic analysis can be run with:./static_analysisRunning a security auditTo run a security audit:./security_auditNote 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 domainsIf 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 thedeploydirectory 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 FontsIf you want to use a particular font then copy it into thefontsdirectory, rename it ascustom.ttf/woff/woff2/otfand then restart the epicyon daemon.systemctlrestartepicyonCustom FaviconIf you want to use your own favicon then copy yourfavicon.icofile to the base directory where you installed Epicyon.Changing ThemesWhen 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 ThemesIf you want to add a new theme then first add the name of your theme to the translations files.Within thethemedirectory 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 oftheme/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 editingepicyon.cssand then reloading the web page. Once you are happy with the results then you can update the changed variable values within yourtheme/yourtheme/theme.jsonfile.Epicyon normally uses one set of CSS files whose variables are then altered per theme. If you want to use entirely bespoke CSS then copyepicyon-*.cssinto 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 TestsTo run the unit tests:python3epicyon.py--testsTo run the network tests. These simulate instances exchanging messages.python3epicyon.py--testsnetwork