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.
 
 
 
 
 
ThatOneCalculator 95ce4151e4 docs: 📝 optional deps 2 days ago
.config fix defaults 1 week ago
.github Move title svg location 4 months ago
.okteto ok-to-test with okteto (#8799) 6 months ago
.vscode Update extensions.json 7 months ago
.yarn/plugins/@yarnpkg 🙏 6 months ago
chart Always `signToActivityPubGet` 3 months ago
custom feat: custom css/assets 4 months ago
cypress Obliteration of Ai-chan 🐱🔫 4 months ago
locales New patron list 1 week ago
packages rename icons.css to icons.scss 3 days ago
scripts wip 6 months ago
.dockerignore Update .dockerignore 6 months ago
.editorconfig Use tabs in json 6 years ago
.gitattributes MisskeyRoom (#5267) 3 years ago
.gitignore feat: Managed hosting complete 4 weeks ago
.node-version Update .node-version 6 months ago
.vsls.json Add .vsls.json 4 years ago
.yarnrc.yml chore: 📦 package upgrades 3 weeks ago
CALCKEY.md cl 1 week ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 6 years ago
CONTRIBUTING.md b3 4 months ago
COPYING feat: auto nsfw detection (#8840) 5 months ago
Dockerfile Docker: patch Docker build 1 month ago
LICENSE Use AGPLv3 5 years ago
Procfile Create Procfile 4 years ago
README.md docs: 📝 optional deps 2 days ago
SECURITY.md Create SECURITY.md 2 years ago
calckey.nginx.conf docs: 📝 improve documentation, nginx 2 weeks ago
cypress.config.ts update cypress 6 months ago
docker-compose.yml change links to depends_on in docker-compose.yml 3 weeks ago
gulpfile.js more fixes 1 week ago
package.json disable blurEffect on mobile due to it causing problems 3 days ago
patrons.json Add Sky to patrons list 1 week ago

README.md

Calckey logo

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

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
    • 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 v18.12.1 (v19.1.0 recommended)
    • Install with nvm
  • 🐘 At least PostgreSQL v12
  • 🍱 At least Redis v6 (v7 recommended)

😗 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 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

🐘 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/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-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
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

  • 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 $(seq 3000 4000); do ss -tlnH | tr -s ' ' | cut -d" " -sf4 | grep -q "${p}$" || echo "${p}"; done | head -n 1
  • 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, 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