hippofish/README.md

🌎 Firefish is an open source, decentralized social media platform that's free forever! 🚀

Firefish is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web UI, rich chatting, and much more!

Links

Want to get involved? Great!

• If you have the means to, donations are a great way to keep us going.
• If you know how to program in TypeScript, Vue, or Rust, read the contributing document and our Developers' Corner .
• If you know a non-English language, translating Firefish on Weblate help bring Firefish to more people. No technical experience needed!

Links

• Donations:
  • OpenCollective: https://opencollective.com/Firefish
• Matrix space: https://matrix.to/#/#firefish-community:nitro.chat
• Official account: @firefish@info.firefish.dev
• Weblate: https://hosted.weblate.org/engage/firefish/

Release cycle

We use a rolling release cycle now. Small updates will be frequently merged into the main branch, so please upgrade regularly at your convenience. We will use the commit date (e.g., 20240206) as the version number.

Any special operations required for an upgrade (e.g., installing new dependencies, editing docker-compose.yml) will be noted on docs/notice-for-admins.md , so please check it before upgrading.

As always, please take a backup first before starting update. Whether it is a server snapshot backup or a complete database and file backup, it will be of great help to your recovery process.

Getting started

This guide will work for both starting from scratch and migrating from Misskey.

Containerization

• How to run Firefish with Docker
• How to run Firefish with Kubernetes/Helm

Install Production Environment

For install production environment details, read this document.

Dependencies

• At least NodeJS v18.16.0 (v20/v21 recommended)
• At least PostgreSQL v12 (v16 recommended) with PGroonga extension
• At least Redis v7
• Web Proxy (one of the following)
  • Caddy (recommended for new users)
  • Nginx (recommended)
  • Apache

Optional dependencies

• FFmpeg for video transcoding
• Caching server (one of the following)
  • DragonflyDB (recommended)
  • KeyDB
  • Another Redis server

Build dependencies

• At least Rust v1.74
• C/C++ compiler & build tools
  • build-essential on Debian/Ubuntu Linux
  • base-devel on Arch Linux
• Python 3

Migrating from Misskey/FoundKey to Firefish

For migrating from Misskey v13, Misskey v12, and FoundKey, read this document.