| .config | ||
| .vscode | ||
| .woodpecker | ||
| chart | ||
| custom | ||
| cypress | ||
| dev | ||
| docs | ||
| issue_template | ||
| locales | ||
| packages | ||
| scripts | ||
| .dockerignore | ||
| .editorconfig | ||
| .envrc | ||
| .gitattributes | ||
| .gitignore | ||
| .node-version | ||
| .npmrc | ||
| .vsls.json | ||
| .weblate | ||
| calckey.apache.conf | ||
| CALCKEY.md | ||
| calckey.nginx.conf | ||
| CHANGELOG.md | ||
| cliff.toml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| cypress.config.ts | ||
| docker-compose.yml | ||
| Dockerfile | ||
| flake.lock | ||
| flake.nix | ||
| gulpfile.js | ||
| LICENSE | ||
| package.json | ||
| patrons.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| Procfile | ||
| pull_request_template.yml | ||
| README.md | ||
| release.json | ||
| rome.json | ||
| SECURITY.md | ||
| title_float.svg | ||
✨ 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 server admins alike.
- Read this document all for current and future differences.
- Notable differences:
- Improved UI/UX (especially on mobile)
- Post editing
- Content importing
- Improved notifications
- Improved server security
- Improved accessibility
- Improved threads
- Recommended Servers timeline
- OCR image captioning
- New and improved Groups
- Better intro tutorial
- Compatibility with Mastodon clients/apps
- Backfill user information
- Advanced search
- Many more user and admin settings
- So much more!
🥂 Links
Want to get involved? Great!
- If you have the means to, donations are a great way to keep us going.
- If you know how to program in TypeScript, Vue, or Rust, read the contributing document.
- If you know a non-English language, translating Calckey on Weblate help bring Calckey to more people. No technical experience needed!
- Want to write/report about us, have any professional inquiries, or just have questions to ask? Contact us here!
All links
- 🌐 Homepage: https://calckey.org
- 💸 Donations:
- OpenCollective: https://opencollective.com/Calckey
- Liberapay: https://liberapay.com/ThatOneCalculator
- Donate publicly to get your name on the Patron list!
- 🚢 Flagship server: https://calckey.social
- 💁 Matrix support room: https://matrix.to/#/#calckey:matrix.fedibird.com
- 📣 Official account: https://i.calckey.cloud/@calckey
- 📜 Server list: https://calckey.org/join
- ✍️ Weblate: https://hosted.weblate.org/engage/calckey/
- ️️📬 Contact: https://calckey.org/contact/
🌠 Getting started
Want to just join a Calckey server? View the list here, pick one, and join:
https://calckey.org/join
Want to make your own? Keep reading!
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.
🛳️ Containerization
🧑💻 Dependencies
- 🐢 At least NodeJS v18.16.0 (v20 recommended)
- 🐘 At least PostgreSQL v12 (v14 recommended)
- 🍱 At least Redis v6 (v7 recommended)
- Web Proxy (one of the following)
- 🍀 Nginx (recommended)
- 🦦 Caddy
- 🪶 Apache
- ⚡ libvips
😗 Optional dependencies
- FFmpeg for video transcoding
- Full text search (one of the following)
- Caching server (one of the following)
- 🐲 DragonflyDB (recommended)
- 👻 KeyDB
- 🍱 Another Redis server
🏗️ Build dependencies
- 🦀 At least Rust v1.68.0
- 🦬 C/C++ compiler & build tools
build-essentialon Debian/Ubuntu Linuxbase-develon Arch Linux
- 🐍 Python 3
👀 Get folder ready
git clone https://codeberg.org/calckey/calckey.git
cd calckey/
Note
By default, you're on the develop branch. Run
git checkout mainorgit checkout betato switch to the Main/Beta 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
pm2
To install pm2 run:
npm i -g pm2
pm2 install pm2-logrotate
Note
pm2-logrotateensures that log files don't infinitely gather size, as Calckey produces a lot of logs.
🐘 Create database
In PostgreSQL (psql), run the following command:
CREATE DATABASE calckey WITH encoding = 'UTF8';
or run the following from the command line:
psql postgres -c "create database calckey with encoding = 'UTF8';"
In Calckey's directory, fill out the db section of .config/default.yml with the correct information, where the db key is calckey.
💰 Caching server
If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. DragonflyDB is the recommended option due to its unrivaled performance and ease of use.
🔎 Set up search
🦔 Sonic
Sonic is better suited for self hosters with smaller deployments. It uses almost no resources, barely any any disk space, and is relatively fast.
Follow sonic's installation guide
Note
If you use IPv4: in Sonic's directory, edit the
config.cfgfile to changeinetto"0.0.0.0:1491".
In Calckey's directory, fill out the sonic section of .config/default.yml with the correct information.
Meilisearch
Meilisearch is better suited for larger deployments. It's faster but uses far more resources and disk space.
Follow Meilisearch's quick start guide
In Calckey's directory, fill out the meilisearch section of .config/default.yml with the correct information.
ElasticSearch
Please don't use ElasticSearch unless you already have an ElasticSearch setup and want to continue using it for Calckey. ElasticSearch is slow, heavy, and offers very few benefits over Sonic/Meilisearch.
💅 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 onhttps://yourserver.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/badgesdirectory, replacing the files already there. - To add custom sounds, place only mp3 files in the
./custom/assets/soundsdirectory. - To update custom assets without rebuilding, just run
pnpm run gulp.
🧑🔬 Configuring a new server
- 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.envto.config/docker.envif you're using Docker.
🚚 Migrating from Misskey/FoundKey to Calckey
For migrating from Misskey v13, Misskey v12, and FoundKey, read this document.
🌐 Web proxy
🍀 Nginx (recommended)
- Run
sudo cp ./calckey.nginx.conf /etc/nginx/sites-available/ && cd /etc/nginx/sites-available/ - Edit
calckey.nginx.confto reflect your server properly - Run
sudo ln -s ./calckey.nginx.conf ../sites-enabled/calckey.nginx.conf - Run
sudo nginx -tto validate that the config is valid, then restart the NGINX service.
🦦 Caddy
- Add the following block to your
Caddyfile, replacingexample.tldwith your own domain:
example.tld {
reverse_proxy http://127.0.0.1:3000
}
- Reload your caddy configuration
🪶 Apache
Warning
Apache has some known problems with Calckey. Only use it if you have to.
- Run
sudo cp ./calckey.apache.conf /etc/apache2/sites-available/ && cd /etc/apache2/sites-available/ - Edit
calckey.apache.confto reflect your server properly - Run
sudo a2ensite calckey.apacheto enable the site - Run
sudo service apache2 restartto 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';(replace999999with the copied ID) - Restart your Calckey server