Algernon

Access

• Open your browser: https://<SERVER-IP>
• The TLS certificate is self-signed, so accept the browser certificate warning on the first visit.
• Plain HTTP automatically redirects to HTTPS: http://<SERVER-IP>

Publish Content

Place your website files in: /srv/algernon

Algernon supports:

• HTML files: Served as-is
• Markdown files: Rendered automatically
• Lua pages: Executed as dynamic pages, including index.lua and other .lua files

Important Files & Directories

• Binary: /usr/local/bin/algernon
• Web Root: /srv/algernon
• TLS Certificate: /etc/algernon/cert.pem
• TLS Private Key: /etc/algernon/key.pem
• Bolt Database: /var/lib/algernon/algernon.db
• systemd Unit: /etc/systemd/system/algernon.service

Service Management

Algernon runs as a systemd service and starts automatically at boot.

Check the service status:

systemctl status algernon

Restart Algernon after editing website files if the changes are not reflected immediately:

systemctl restart algernon

View the service logs:

journalctl -u algernon -f

If you do not want to use the provided systemd service, stop and disable it:

systemctl disable --now algernon

You can then run Algernon manually or create your own custom systemd service. View the available command-line options with:

algernon -h

Notes

• Algernon runs as the dedicated algernon system user.
• Files added to /srv/algernon should be accessible to the algernon user.
• If you encounter permission issues with files in the web root, ensure they are owned by algernon: chown -R algernon:algernon /srv/algernon
• HTTPS and HTTP/2 are enabled directly by Algernon.
• HTTP traffic is redirected to HTTPS.
• The service binds to ports 80 and 443 without running as root.