A greatly enhanced fork of Misskey with better UI/UX, security, features, and more! https://calckey.social
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Kainoa Kanter bb0fe93631
ci/woodpecker/push/dockerHubTag Pipeline was successful Details
ci/woodpecker/push/commit Pipeline was successful Details
ci/woodpecker/tag/commit Pipeline was successful Details
ci/woodpecker/push/testDocker Pipeline was successful Details
ci/woodpecker/pr/commit Pipeline was successful Details
ci/woodpecker/pr/dockerHubTag Pipeline was successful Details
ci/woodpecker/tag/dockerHubTag Pipeline was successful Details
ci/woodpecker/tag/dockerHubRelease Pipeline was successful Details
ci/woodpecker/pr/dockerHubRelease Pipeline was successful Details
ci/woodpecker/pr/testDocker Pipeline was successful Details
ci/woodpecker/push/dockerHubRelease Pipeline was successful Details
ci/woodpecker/tag/testDocker Pipeline was successful Details
Merge branch 'develop' of codeberg.org:calckey/calckey into develop
1 hour ago
.config TWA/assetlinks support 2 weeks ago
.okteto ok-to-test with okteto (#8799) 8 months ago
.vim no more eslint 3 weeks ago
.vscode vscode: replace eslint with rome 3 weeks ago
.woodpecker Update '.woodpecker/dockerHubTag.yml' 1 day ago
chart Always `signToActivityPubGet` 6 months ago
custom Rework `custom` behaviour 2 months ago
cypress no more eslint 3 weeks ago
dev postgres: revert to 12.2 version 2 months ago
issue_template lavaforge --> codeberg until lavaforge is ready 2 weeks ago
locales feat: dialog to remove follower 1 day ago
packages fix: reactions using unicode weren't processed 19 hours ago
scripts refactor: 🔨 Use pnpm instead of yarn (#9461) 3 weeks ago
.dockerignore refactor: 🔨 Use pnpm instead of yarn (#9461) 3 weeks ago
.editorconfig Use tabs in json 6 years ago
.gitattributes MisskeyRoom (#5267) 4 years ago
.gitignore styling 4 days ago
.node-version Update .node-version 8 months ago
.vsls.json Add .vsls.json 5 years ago
CALCKEY.md refactor: 🎨 rome 3 weeks ago
CHANGELOG.md update changelog 2 days ago
CODE_OF_CONDUCT.md Add contact method 2 months ago
CONTRIBUTING.md refactor: 🔨 Use pnpm instead of yarn (#9461) 3 weeks ago
COPYING Add Calckey copyright 2 months ago
Dockerfile no more eslint 3 weeks ago
LICENSE Use AGPLv3 5 years ago
Procfile Create Procfile 4 years ago
README.md Update 'README.md' 4 days ago
SECURITY.md minor spelling mistake 2 months ago
calckey.nginx.conf docs: 📝 improve documentation, nginx 3 months ago
cliff.toml fix: Header of cliff.toml changed to automatically link to calckey.md 1 month ago
cypress.config.ts update cypress 8 months ago
docker-README.md refactor: 🔨 Use pnpm instead of yarn (#9461) 3 weeks ago
docker-compose.yml postgres: revert to 12.2 version 2 months ago
gulpfile.js Rework `custom` behaviour 2 months ago
package.json bump version number 1 hour ago
patrons.json chore: update patrons 3 weeks ago
pnpm-lock.yaml fix lock 4 days ago
pnpm-workspace.yaml refactor: 🔨 Use pnpm instead of yarn (#9461) 3 weeks ago
release.json improve release notes 4 days ago
rome.json refactor: 🎨 rome 3 weeks ago
title_float.svg refactor: rm .github folder 2 months ago

README.md

Calckey logo

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

no github badge status badge liberapay badge translate-badge docker badge Contributor Covenant Codeberg badge

Calc (the Calckey mascot) smoking a fat dart

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
    • Fediverse account migration
    • Improved instance security
    • Improved accessibility
    • 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.

🔰 Easy installers

If you have access to a server that supports one of the sources below, I recommend you use it! Note that these methods won't allow you to migrate from Misskey without manual intervention.

Install on Ubuntu  Install on the Arch User Repository  Install Calckey with YunoHost

🐋 Docker

How to run Calckey with Docker.

🧑‍💻 Dependencies

  • 🐢 At least NodeJS v18.12.1 (v19 recommended)
    • Install with nvm
  • 🐘 At least PostgreSQL v12
  • 🍱 At least Redis v6 (v7 recommend)

😗 Optional dependencies

  • FFmpeg for video transcoding
  • ElasticSearch for full-text search
    • OpenSearch/Sonic are not supported as of right now
  • Management (choose one of the following)
    • 🛰️ pm2
    • 🐳 Docker
    • Service manager (systemd, openrc, etc)

🏗️ Build dependencies

  • 🦬 C/C++ compiler & build tools
    • build-essential on Debian/Ubuntu Linux
    • base-devel on Arch Linux
  • 🐍 Python 3

👀 Get folder ready

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

📩 Install dependencies

# nvm install 19 && nvm use 19
corepack enable
corepack prepare pnpm@latest --activate
# To build without TensorFlow, append --no-optional
pnpm i # --no-optional

🐘 Create database

Assuming you set up PostgreSQL correctly, all you have to run is:

psql postgres -c "create database calckey with encoding = 'UTF8';"

💅 Customize

  • To add custom CSS for all users, edit ./custom/assets/instance.css.
  • To add static assets (such as images for the splash screen), place them in the ./custom/assets/ directory. They'll then be available on https://yourinstance.tld/static-assets/filename.ext.
  • To add custom locales, place them in the ./custom/locales/ directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: en-FOO.yml)
  • To update custom assets without rebuilding, just run pnpm 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 .

🍀 NGINX

  • Run sudo cp ./calckey.nginx.conf /etc/nginx/sites-available/ && cd /etc/nginx/sites-available/
  • 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 + pm2

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

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

😉 Tips & Tricks

  • When editing the config file, please don't fill out the settings at the bottom. They're designed only for managed hosting, not self hosting. Those settings are much better off being set in Calckey's control panel.
  • Port 3000 (used in the default config) might be already used on your server for something else. To find an open port for Calckey, run for p in {3000..4000}; do ss -tlnH | tr -s ' ' | cut -d" " -sf4 | grep -q "${p}$" || echo "${p}"; done | head -n 1. Replace 3000 with the minimum port and 4000 with the maximum port if you need it.
  • I'd recommend you use a S3 Bucket/CDN for Object Storage, especially if you use Docker.
  • 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, then 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