firefish/README.md

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

✨ About Calckey

• Calckey 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!
• Calckey adds many quality of life changes and bug fixes for users and instance admins alike.
• Read this document all for current and future differences.
• Notable differences:
  • Improved UI/UX (especially on mobile)
  • Improved notifications
  • Improved instance security
  • Recommended Instances timeline
  • OCR image captioning
  • New and improved Groups
  • Better intro tutorial
  • Many more user and admin settings
  • So much more!

🥂 Links

• 💸 Liberapay: https://liberapay.com/ThatOneCalculator
• 💁 Matrix support room: https://matrix.to/#/#calckey:matrix.fedibird.com
• 📜 Instance list: https://calckey.fediverse.observer/list
• 📖 JoinFediverse Wiki: https://joinfediverse.wiki/What_is_Calckey%3F

🌠 Getting started

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

📦 Dependencies

• At least 🐢 NodeJS v16.15.0 (v18.12.1 recommended)

⚠️ NodeJS v19 is not supported as of right now because of this issue.

• 🧶 At least Yarn v3

• 🐘 At least PostgreSQL v12

• 🍱 At least Redis v6 (v7 recommended)

• 🛰️ (Optional, for non-Docker) pm2

👀 Get folder ready

git clone https://codeberg.org/thatonecalculator/calckey.git
cd calckey/
# git checkout main # if you want only stable versions

📩 Install dependencies

# nvm install 18 && nvm alias default 18 && nvm use 18
corepack enable

💅 Customize

• To add custom CSS for all users, edit ./custom/instance.css.
• To add static assets (such as images for the splash screen), place them in the ./custom/ directory. They'll then be avaliable on https://yourinstance.tld/static-assets/filename.ext.

🚚 Migrating from Misskey to Calckey

⚠️ Because of their changes, migrating from Foundkey is not supported.

cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, replace `default.yml` with `docker.yml` if you use docker
cp -r ../misskey/files . # if you don't use object storage

🍀 NGINX

Read https://misskey-hub.net/en/docs/admin/nginx.html

🚀 Build and launch!

🐢 NodeJS

git pull and run these steps to update Calckey in the future!

# git pull
yarn install
NODE_ENV=production yarn run build && yarn run migrate
pm2 start "NODE_ENV=production yarn start" --name Calckey

🐋 Prebuilt Docker image

docker pull thatonecalculator:calckey
docker up -d

🐳 Docker Compose

sudo docker compose build
sudo docker-compose run --rm web yarn run init
sudo docker compose up -d

😉 Tips & Tricks

• To generate ServiceWorker keys, run npx web-push generate-vapid-keys
• I'd strongly recommend against using CloudFlare, but if you do, make sure to turn code minification off.