A greatly enhanced fork of Misskey with better UI/UX, security, features, and more!
Go to file
ThatOneCalculator f81492e835 docs: 📝 improve documentation, nginx 2022-11-15 20:16:50 -08:00
.config Update config example 2022-11-16 04:51:59 +01:00
.github Move title svg location 2022-08-08 15:10:31 -07:00
.okteto ok-to-test with okteto (#8799) 2022-06-09 00:50:23 +09:00
.vscode Update extensions.json 2022-05-14 18:50:16 +09:00
.yarn/plugins/@yarnpkg 🙏 2022-05-31 00:13:41 -07:00
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 replayTutorial 2022-11-13 12:06:39 -08:00
packages another i18n fix 2022-11-15 11:47:30 -08:00
scripts wip 2022-06-04 08:01:02 +00:00
.dockerignore Update .dockerignore 2022-05-31 08:33:03 -07:00
.editorconfig Use tabs in json 2017-05-24 20:27:39 +09:00
.gitattributes MisskeyRoom (#5267) 2019-08-18 14:41:33 +09:00
.gitignore feat: Managed hosting complete 2022-11-01 18:41:59 -07:00
.node-version Update .node-version 2022-06-06 21:01:00 +09:00
.vsls.json Add .vsls.json 2018-08-13 00:24:45 +09:00
.yarnrc.yml chore: 📦 package upgrades 2022-11-09 17:21:09 -08:00
CALCKEY.md typo 2022-11-14 18:54:03 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-17 10:01:05 +09:00
CONTRIBUTING.md b3 2022-07-21 12:48:23 -07:00
COPYING feat: auto nsfw detection (#8840) 2022-07-07 21:06:37 +09:00
Dockerfile Docker: patch Docker build 2022-10-26 08:04:19 +03:00
LICENSE Use AGPLv3 2018-03-28 22:56:28 +09:00
Procfile Create Procfile 2019-04-05 18:17:30 +09:00
README.md docs: 📝 improve documentation, nginx 2022-11-15 20:16:50 -08:00
SECURITY.md Create SECURITY.md 2021-05-24 05:50:45 +09:00
calckey.nginx.conf docs: 📝 improve documentation, nginx 2022-11-15 20:16:50 -08:00
cypress.config.ts update cypress 2022-06-11 15:53:45 +09:00
docker-compose.yml change links to depends_on in docker-compose.yml 2022-11-06 19:04:57 -08:00
gulpfile.js oopsie 2022-11-06 19:44:26 -08:00
package.json .14 2022-11-15 01:02:05 -08:00

README.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
    • Better intro tutorial
    • 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 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.
  • To update custom assets without rebuilding, just run yarn run gulp.

🧑‍🔬 Configuring a new instance

  • Run cp .config/example.yml .config/default.yml
  • Edit .config/default.yml, making sure to fill out required fields.
  • Also copy and edit .config/docker_example.env to .config/docker.env if you're using Docker.

🚚 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, add `docker.env` if you use Docker
cp -r ../misskey/files . # if you don't use object storage

🍀 NGINX

  • Run sudo cp ./calckey.nginx.conf /etc/nginx/sites-avaliable/ && cd /etc/nginx/sites-avaliable/
  • Edit calckey.nginx.conf to reflect your instance properly
  • Run sudo cp ./calckey.nginx.conf ../sites-enabled/
  • Run sudo nginx -t to validate that the config is valid, then restart the NGINX service.

🚀 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

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

😉 Tips & Tricks

  • I'd strongly recommend against using CloudFlare, but if you do, make sure to turn code minification off.
  • For push notifications, run npx web-push generate-vapid-keys, the put the public and private keys into Control Panel > General > ServiceWorker.
  • For translations, make a DeepL account and generate an API key, then put it into Control Panel > General > DeepL Translation.
  • To add another admin account:
    • Go to the user's page > 3 Dots > About > Moderation > turn on "Moderator"
    • Go back to Overview > click the clipboard icon next to the ID
    • Run psql -d calckey (or whatever the database name is)
    • Run UPDATE "user" SET "isAdmin" = true WHERE id='999999'; (replace 999999 with the copied ID)
    • Have the new admin log out and log back in