Fork 0
Notes and scripts for Calckey. https://spacecruft.org/deepcrayon/calckey-cruft
Go to file
root 7175398750 Initial screenshot 2023-05-10 16:59:47 -06:00
img Add screenshot of initial screen 2023-05-10 16:59:24 -06:00
.gitignore Ignore temp files 2023-05-10 15:31:47 -06:00
LICENSE-AGPL GNU Affero General Public License Version 3 2023-05-10 15:31:37 -06:00
LICENSE-CC Creative Commons Attribution-ShareAlike 4.0 International 2023-05-10 15:31:11 -06:00
README.md Initial screenshot 2023-05-10 16:59:47 -06:00



Calckey is Fediverse "social media" software similar to Mastodon.

Below are some notes about a test installation setup.





Tested on Debian 11 (Stable/Bullseye).

Not using Docker or Elasticsearch.

Install some dependencies from Debian repos:

apt update
apt install build-essential curl python3 python-is-python3 postgresql \
            ffmpeg nginx

apt install -t bullseye-backports redis


Calckey recommends using nvm to manage NodeJS versions. So run:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

The log out/in or run:

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"

Then install the right version of npm with nvm:

nvm install 19
nvm use 19

Confirm correct version is running:

node -v

Download and Install


git clone https://codeberg.org/calckey/calckey
cd calckey/

The default branch is main. If you want to do a different branch, check it out, ala:

git checkout remotes/origin/develop

Install calckey NodeJS dependencies:

corepack enable
corepack prepare pnpm@latest --activate
pnpm i
# pnpm i --no-optional # without Tensorflow. Downloads it anyway.


Setup thusly.


Database creation (change username at end):

sudo -u postgres createuser --createdb --pwprompt debian

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


Setup web proxy.

sudo cp ./calckey.nginx.conf /etc/nginx/sites-available/
cd /etc/nginx/sites-available/
sudo $EDITOR calckey.nginx.conf
cd ../sites-enabled/
sudo ln -s ../sites-available/calckey.nginx.conf .
sudo nginx -t
sudo systemctl restart nginx

Configure Calckey

Configure thusly.

Go back to the Calckey git directory cloned above.

cp .config/example.yml .config/default.yml
$EDITOR .config/default.yml

Set, like my example:

  • url: https://rs-calckey.jebba.moe/
  • db user: debian # and other needed db settings

Build Calckey

Build thusly.

pnpm install
NODE_ENV=production pnpm run build

This will set up the database. If it fails here, check Postgres.

pnpm run migrate

Run Calckey

Run thusly.

NODE_ENV=production pnpm run start


Go to Calckey using the url in .config/default.yml. Example:


The first user you create will be the admin user.

Calckey default inital screen.


Unofficial project, not part of official Calckey software or website. Upstream sources under their respective copyrights.

License: CC By SA 4.0 International and/or AGPLv3+ at your discretion.

Copyright © 2023, Jeff Moe.