Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Documentation

Self-hosting

  • native.md: Linux hosting as a dedicated meowcord user, systemd restrictions, PostgreSQL, HTTPS, voice, backups and updates without Docker.
  • databases.md: PostgreSQL and SQLite selection, migrations and backups.
  • setup.md: native hosting entry point, Docker and development setup, and the first operator account.
  • deploy.md: production with Docker Compose, backups, updates, reverse proxies and phones.
  • external-services.md: every outside service the instance can contact and how each is turned on.
  • stickers.md: provisioning the standard sticker artwork locally and editing sticker packs.
  • verification.md: how an instance gets approved, how instance admins verify servers for global discovery, and who can remove or block what.
  • registry.md: the federation registry Worker, its endpoints, how we review instances and discovery servers, and how an instance gets listed.
  • change-url.md: moving an instance to a new address without losing its users, servers and DMs on other instances.

Features

  • admin.md: the admin dashboard at /admin.
  • activities.md: embedded activities, their hosting and API.
  • announcements.md: encrypted announcements from the official account.
  • automod.md: the slur auto-ban, word lists, join reasons, account approval, sign-in and signup limits, spam rules, raid detection, server AutoMod rules and the Automod admin page with its raid incidents.
  • captcha.md: Cap challenge work for registration, sign-in and password reset, and refusing automated browsers.
  • discovery.md: what Discover lists, how search and ranking work, the search index, categories and keywords.
  • e2ee.md: end-to-end encrypted DMs, key backup and recovery.
  • federation.md: Other instances in Discovery, chat with servers and people on other instances, the owner switch, the Federation admin page, its config keys and endpoints.
  • link-embeds.md: link previews, video players and components media.
  • homepage.md: the instance homepage at / and the settings that change it.
  • identity-moderation.md: blocked words in usernames, display names and nicknames.
  • invites.md: invite-only registration, member and staff instance invites, and invite trees.
  • loading-screen.md: custom loading tips and loading animation.
  • notifications.md: notification settings, mention counts, read states and Web Push.
  • pride-badges.md: the pride flag catalog and picking flags at signup.
  • profile-widgets.md: application profile widgets made in the developer portal.
  • signup.md: Cap verification on registration.

Security

Development