jormungandr-bite/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:
  • Recommended Instances timeline
  • Improved notifications
  • Many more user and admin settings

📝 Documentation

• Misskey documentation can be found on Misskey Hub
• API reference can be found on any Calckey instance's API doc page

🚚 Migrating from Misskey to Calckey

You need at least 🐢 NodeJS v16.15.0 (v18.4.0 recommended!) and exactly 🧶 Yarn v3.2.2!

📩 Install dependencies

# nvm install 18.4.0 && nvm alias default 18.4.0 && nvm use 18.4.0
corepack enable
yarn set version berry

👀 Get folder ready

git clone https://codeberg.org/thatonecalculator/calckey.git
cd calckey/
# git checkout main # if you want only stable versions
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

💅 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/ folder. They'll then be avaliable on https://yourinstance.tld/static-assets/filename.png.

🚀 Build and launch!

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
# Edit service to point to calckey folder and restart!

🐳 Docker

# git pull
sudo docker-compose build
sudo docker-compose stop && sudo docker-compose up -d

💸 Patrons

None yet! You can support of the development of this fork here, every little bit counts: https://liberapay.com/ThatOneCalculator/