Documentation · Catodon

Faire tourner une instance

Installing and running Catodon Catodon is Sharkey at heart, so the Sharkey installation guide still applies for the base setup. Use the Catodon repository (https://codefloe.com/catodon/catodon) instead of Sharkey's. 30 min de lecture Backing up before an upgrade Every upgrade instruction in this repo starts with "back up your database and files first." This page is the simple, step-by-step version of how to actually do that — pick your path: 6 min de lecture Upgrading your in-memory store from Redis to Valkey Catodon now ships Valkey instead of Redis as its bundled in-memory store (used for caching, pub/sub, and the job queue). This page is a step-by-step runbook for moving an existing installation over. For the reasoning… 9 min de lecture Migrating from Misskey to Catodon Catodon descends from Misskey through Sharkey, so a Misskey server's database can be carried over in place: your accounts, posts, files, follows and settings stay as they are, and Catodon's migrations bring the schema… 6 min de lecture Downgrading a Catodon instance to Sharkey This is a runbook, not a script. It is deliberately not automated: this procedure is run approximately never, and a script that silently rots as upstream Sharkey drifts is more dangerous than a documented, re-verified… 23 min de lecture

API et applications

ActivityPub client API Catodon implements the client-to-server half of ActivityPub (W3C REC §5–§6), following the SocialCG ActivityPub API Task Force's Basic Profile for ActivityPub API Servers. A generic ActivityPub app can sign an account… 11 min de lecture Lemmy-compatible forum API Catodon answers three read-only requests in the shape of Lemmy's API v3 (Lemmy 0.19), so that forum directories and crawlers written for Lemmy can find the public forums of a Catodon server. "Forum" is Catodon's word… 6 min de lecture Push notifications in the Aria app Aria (the cross-platform Misskey-family client) sets up push notifications by showing an AiScript snippet and telling you to open your server's Scratchpad page (https://your-server/scratchpad), paste the snippet, run… 2 min de lecture

Développer Catodon

Development How to get a Catodon development instance running, how to test it, and the conventions and traps of this codebase. For the social side of contributing (what to open an issue about, how pull requests are handled), see… 25 min de lecture Merging upstream into Catodon Catodon is a fork of Sharkey, which is a fork of Misskey. Changes therefore travel down a chain: Misskey to Sharkey, Sharkey to Catodon. 5 min de lecture Upstream map What a port from Misskey needs before reading a single hunk: for each upstream path, which file here holds that code, how far that file has drifted, and which other files here carry a copy of the same code. Merging… 13 min de lecture Ranked timeline hydration The Redis-backed Hot and Active paths in FanoutTimelineEndpointService now select ranking columns first, check eligibility in bounded batches in rank order, and load the original full graph only for the selected page.… 11 min de lecture

Autres pages

Custom widgets: for administrators Custom widgets let an administrator put their own small web pages, or a third party's embed code, into the widget column beside the built-in widgets, and choose which widgets new accounts start with. They are in Control… 3 min de lecture Events An event is a post with a date and a place: a concert, a meeting, a book club, a protest. Catodon shows events from other servers (Mobilizon, Gancio, Friendica, Hubzilla and others), lets you post your own, and lets… 7 min de lecture Events: federation notes What Catodon sends and accepts for events, and what each piece of fediverse software it was tested against does with them. This page is for developers and administrators. For users, see Events. 13 min de lecture Events: for administrators What events add to a Catodon server, and what an administrator may want to know or change. For how events work for users, see Events; for what other servers do with them, Events: federation notes. 4 min de lecture Receiving webhooks Catodon sends a webhook as an HTTP POST with a JSON body, for the webhooks a user sets up under Settings > Developer > Webhook and for the ones an administrator sets up under Control Panel > Webhooks. This page is for… 3 min de lecture Single sign-on Catodon can let people sign in through an OpenID Connect provider, such as Keycloak, Authentik, Entra ID or any other provider that publishes a discovery document. This page is for the administrator who sets it up.… 8 min de lecture