Skip to content

Eladriagon/apagee

Repository files navigation

Apagee logo

Apagee

GitHub Release GitHub Actions Workflow Status GitHub Repo stars Mastodon Follow

Apagee is a self-hosted, minimalistic, fediverse-first, solo blog engine.

Apa-what?

Apagee is a portmanteau (specifically, an intercalative blend) of apogee and page.

Features

  • Single-user
  • Quick and easy setup
  • Cross-platform (Windows or Linux)
  • Reverse proxy support
  • Full fediverse participation
    • Receive follows and (optionally) auto-follow back
    • Deliver new articles published in Apagee as notes to fediverse followers (appears on timelines as a "status")
    • Track count of boosts/shares and likes/favorites
    • #hashtag support
  • Admin web interface

Instructions

Warning

This is still in alpha. You're welcome to install it and try it out, but things may change while Apagee is still in active development!

Linux (Debian)

Run this to self-install:

wget --cache=off -qO- https://raw.githubusercontent.com/Eladriagon/apagee/main/install/install.sh | bash

You should always review shell scripts before executing them. Here is a link to the script to review:

https://raw.githubusercontent.com/Eladriagon/apagee/main/install/install.sh

It performs the following tasks:

  • Installs required dependencies via apt-get update && apt-get install ...
  • Creates user apagee / group apagee
  • Downloads the release marked "Latest" from this Github repo
  • Extracts it to /home/apagee/apagee
  • Runs setcap to allow binding to 80/443
  • (Re-)registers apagee.service in systemctl
  • Starts the service

All other OSes

Not yet supported but you're welcome to try!

The releases contain precompiled binaries that should run on most Linux and Windows OSes.

Todo List

  • JSON configuration file with environment variable overrides
  • SQLite database
  • Automatic admin login creation with UI for password change
  • Auto-generated Fediverse signing keys stored locally
  • Author articles in Markdown
  • Draft articles
  • View article list
  • Delete articles
  • Accept and track followers, and respond to follow requests
  • Custom profile properties
  • Send Fediverse activities
  • Receive boosts/favorites from Fediverse
  • Tags
  • Media (paste from clipboard)
  • Advertising a quote policy and accepting quote requests
  • Better emoji support (Noto Color Emoji or Twemoji?)
  • Dockerize and publish image
  • "Primary" image for Fediverse posts
  • Read more cutoff tag
  • Project logo
  • Project documentation