A greatly enhanced fork of Misskey with better UI/UX, security, features, and more!
Go to file
Kainoa Kanter 6b9b4a6866
Merge pull request 'docs: Add Apache2 documentation' (#10078) from warrows/calckey:main into main
Reviewed-on: https://codeberg.org/calckey/calckey/pulls/10078
2023-05-10 17:08:51 -07:00
.config Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
.vim no more eslint 2023-01-12 20:54:33 -08:00
.vscode vscode: replace eslint with rome 2023-01-14 14:33:15 +01:00
.woodpecker Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
chart adding calckey helm chart 2023-05-10 16:07:45 -07:00
custom fix sounds settings 2023-03-29 13:38:59 -07:00
cypress Nya 2023-02-10 07:10:42 +00:00
dev postgres: revert to 12.2 version 2022-12-19 02:57:51 +02:00
docs Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
issue_template lavaforge --> codeberg until lavaforge is ready 2023-01-19 16:18:17 -08:00
locales chore: Merge branch 'origin/develop' into Weblate. 2023-05-10 23:09:28 +02:00
packages Merge pull request 'keyboard-accessibility' (#10084) from Freeplay/calckey:keyboard-accessibility into develop 2023-05-10 22:20:57 +00:00
scripts refactor: 🔨 Use pnpm instead of yarn (#9461) 2023-01-13 04:18:16 +00:00
.dockerignore build: reduce container size by removing dev dependencies from final image 2023-02-03 21:38:40 -08:00
.editorconfig Use tabs in json 2017-05-24 20:27:39 +09:00
.envrc feat: Add Nix development flake with flake-parts 2023-05-07 12:10:36 +00:00
.gitattributes MisskeyRoom (#5267) 2019-08-18 14:41:33 +09:00
.gitignore Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
.node-version Update .node-version 2022-06-06 21:01:00 +09:00
.npmrc pnpm 8! 2023-03-26 00:37:11 -07:00
.vsls.json Add .vsls.json 2018-08-13 00:24:45 +09:00
.weblate chore: add weblate config file 2023-04-16 19:38:29 -07:00
CALCKEY.md Hyperlink more remote commits 2023-04-12 03:52:22 +09:00
CHANGELOG.md docs: 📝 changelog 2023-02-09 14:51:47 -08:00
CODE_OF_CONDUCT.md Add contact method 2022-12-12 22:03:22 -08:00
CONTRIBUTING.md Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
COPYING Add Calckey copyright 2022-12-13 20:23:58 +01:00
Dockerfile fix: 🐛 add zip/unzip to docker container 2023-05-08 14:06:15 -07: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 Merge pull request 'docs: Add Apache2 documentation' (#10078) from warrows/calckey:main into main 2023-05-10 17:08:51 -07:00
SECURITY.md minor spelling mistake 2022-12-13 17:33:50 +00:00
calckey.apache.conf Merge pull request 'docs: Add Apache2 documentation' (#10078) from warrows/calckey:main into main 2023-05-10 17:08:51 -07:00
calckey.nginx.conf docs: 📝 improve documentation, nginx 2022-11-15 20:16:50 -08:00
cliff.toml fix: Header of cliff.toml changed to automatically link to calckey.md 2023-01-04 16:36:58 +00:00
cypress.config.ts update cypress 2022-06-11 15:53:45 +09:00
docker-compose.yml feat: add sonic to docker 2023-03-23 14:43:21 -07:00
flake.lock feat: Add Nix development flake with flake-parts 2023-05-07 12:10:36 +00:00
flake.nix feat: Add Nix development flake with flake-parts 2023-05-07 12:10:36 +00:00
gulpfile.js refactor: ⬆️ phosphor 2, sorta 2023-03-11 13:00:52 -08:00
package.json dev8 2023-05-10 14:09:06 -07:00
patrons.json chore: patrons 2023-05-08 16:25:13 -07:00
pnpm-lock.yaml Switch to adm-zip for emoji pack handling 2023-05-09 19:19:15 -05:00
pnpm-workspace.yaml Revert "Revert "Incorporate calckey-js into calckey repository (#9820)"" 2023-04-07 17:44:27 -07:00
release.json release notes 2023-03-14 16:55:24 -07:00
rome.json refactor: 🎨 rome 2023-01-12 20:40:33 -08:00
title_float.svg refactor: rm .github folder 2022-12-16 10:44:09 -08:00

README.md

Calckey logo

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

no github badge status badge opencollective 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
    • Improved instance security
    • Improved accessibility
    • Improved threads
    • Recommended Instances timeline
    • OCR image captioning
    • New and improved Groups
    • Better intro tutorial
    • Compatibility with Mastodon clients/apps
    • Backfill user information
    • Sonic search
    • 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

🛳️ Containerization

🧑‍💻 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
  • Full text search (choost one of the following)
  • Management (choose one of the following)
    • 🛰️ pm2
    • 🐳 Docker
    • Service manager (systemd, openrc, etc)

🏗️ Build dependencies

  • 🦀 Rust toolchain
  • 🦬 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

pm2

To install pm2 run:

npm i -g pm2
pm2 install pm2-logrotate

pm2-logrotate ensures that log files don't infinitely gather size, as Calckey produces a lot of logs.

🐘 Create database

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

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.

Follow sonic's installation guide

If you use IPv4: in Sonic's directory, edit the config.cfg file to change inet to "0.0.0.0:1491".

In Calckey's directory, fill out the sonic section of .config/default.yml with the correct information.

💅 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

Choose between NGINX or Apache (we recommend NGINX)

🍀 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 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 2

  • 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