YAMF (Yet another Misskey fork) bringing you no-nonsense fixes, features & improvements you actually want since 2023
Find a file
ThatOneCalculator 41e6945313 feat: 💄 Phosphor icons!
2022-11-06 17:33:20 -08:00
.config update example 2022-11-02 09:14:42 -07:00
.github Move title svg location 2022-08-08 15:10:31 -07:00
.okteto
.vscode
.yarn/plugins/@yarnpkg
chart Always signToActivityPubGet 2022-08-22 23:44:25 -07:00
custom feat: custom css/assets 2022-08-09 13:09:54 -07:00
cypress Obliteration of Ai-chan 🐱🔫 2022-08-08 14:58:27 -07:00
locales test new chat layout 2022-11-06 12:49:37 -08:00
packages feat: 💄 Phosphor icons! 2022-11-06 17:33:20 -08:00
scripts
.dockerignore Update .dockerignore 2022-05-31 08:33:03 -07:00
.editorconfig
.gitattributes
.gitignore feat: Managed hosting complete 2022-11-01 18:41:59 -07:00
.node-version
.vsls.json
.yarnrc.yml fix???? 2022-08-22 22:42:30 -07:00
CALCKEY.md cl 2022-11-06 15:01:42 -08:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
COPYING
cypress.config.ts
docker-compose.yml fix: ⚗️ messaging pagination 2022-11-03 15:37:31 -07:00
Dockerfile Docker: patch Docker build 2022-10-26 08:04:19 +03:00
gulpfile.js feat: custom css/assets 2022-08-09 13:09:54 -07:00
LICENSE
package.json fix: REALLY make sure there's no text decoration 2022-11-06 14:46:17 -08:00
Procfile
README.md docs: more accessible links 2022-11-06 15:06:44 -08:00
SECURITY.md

Calckey logo

🌎 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
    • Many more user and admin settings
    • So much more!

🥂 Links

🌠 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
yarn set version berry

💅 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