A fun, new, open way to experience social media https://calckey.org
You cannot 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 6616f246a4
ci/woodpecker/push/dockerHubReleaseCandidate unknown status Details
ci/woodpecker/push/dockerHubTag Pipeline was successful Details
ci/woodpecker/push/commit Pipeline failed Details
ci/woodpecker/push/testDocker Pipeline was successful Details
ci/woodpecker/push/dockerHubRelease Pipeline was successful Details
docs: cleanup apache
4 weeks ago
.config adding example config 4 weeks ago
.okteto ok-to-test with okteto (#8799) 1 year ago
.vim no more eslint 5 months ago
.vscode vscode: replace eslint with rome 5 months ago
.woodpecker Merge branch 'beta' 3 months ago
chart adding calckey helm chart 4 weeks ago
custom Rework `custom` behaviour 6 months ago
cypress Nya 4 months ago
dev postgres: revert to 12.2 version 6 months ago
issue_template lavaforge --> codeberg until lavaforge is ready 5 months ago
locales chore: 🌐 locale changes 2 months ago
packages hotfix: v13.1.4.1 3 months ago
scripts refactor: 🔨 Use pnpm instead of yarn (#9461) 5 months ago
.dockerignore build: reduce container size by removing dev dependencies from final image 4 months ago
.editorconfig Use tabs in json 6 years ago
.gitattributes MisskeyRoom (#5267) 4 years ago
.gitignore adding calckey helm chart 4 weeks ago
.node-version Update .node-version 1 year ago
.vsls.json Add .vsls.json 5 years ago
CALCKEY.md docs: hyperlink foundkey commits 2 months ago
CHANGELOG.md docs: 📝 changelog 4 months ago
CODE_OF_CONDUCT.md Add contact method 6 months ago
CONTRIBUTING.md Update 'CONTRIBUTING.md' 2 months ago
COPYING Add Calckey copyright 6 months ago
Dockerfile build: reduce container size by removing dev dependencies from final image 4 months ago
LICENSE Use AGPLv3 5 years ago
Procfile Create Procfile 4 years ago
README.md docs: cleanup apache 4 weeks ago
SECURITY.md minor spelling mistake 6 months ago
calckey.apache.conf Doc : Add apache2 basic configuration to documentation 4 weeks ago
calckey.nginx.conf docs: 📝 improve documentation, nginx 7 months ago
cliff.toml fix: Header of cliff.toml changed to automatically link to calckey.md 5 months ago
cypress.config.ts update cypress 12 months ago
docker-README.md refactor: 🔨 Use pnpm instead of yarn (#9461) 5 months ago
docker-compose.yml postgres: revert to 12.2 version 6 months ago
gulpfile.js Rework `custom` behaviour 6 months ago
kubernetes-README.md adding calckey helm chart 4 weeks ago
package.json hotfix: v13.1.4.1 3 months ago
patrons.json Update 'patrons.json' 2 months ago
pnpm-lock.yaml update pnpm locks 4 months ago
pnpm-workspace.yaml refactor: 🔨 Use pnpm instead of yarn (#9461) 5 months ago
release.json docs: 📝 changelog 4 months ago
rome.json refactor: 🎨 rome 5 months ago
title_float.svg refactor: rm .github folder 6 months ago


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)
  • Web Proxy (one of the following)
    • 🍀 Nginx (recommended)
    • 🪶 Apache

😗 Optional dependencies

🏗️ 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/

By default, you're on the development branch. Run git checkout beta or git checkout main to switch to the Beta/Main branches.

📩 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 add custom error images, place them in the ./custom/assets/badges directory, replacing the files already there.
  • To add custom sounds, place only mp3 files in the ./custom/assets/sounds directory.
  • 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

For migrating from Misskey v13, Misskey v12, and Foundkey, read this document.

🌐 Web proxy

  • 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 ln -s ./calckey.nginx.conf ../sites-enabled/calckey.nginx.conf
  • Run sudo nginx -t to validate that the config is valid, then restart the NGINX service.

🪶 Apache

  • Run sudo cp ./calckey.apache.conf /etc/apache2/sites-available/ && cd /etc/apache2/sites-available/
  • Edit calckey.apache.conf to reflect your instance properly
  • Run sudo a2ensite calckey.apache to enable the site
  • Run sudo service apache2 restart to reload apache2 configuration

🚀 Build and launch!

🐢 NodeJS + pm2

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

# git pull
pnpm install
NODE_ENV=production 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