A greatly enhanced fork of Misskey with better UI/UX, security, features, and more!
Go to file
Natty dc47c8eba2
ci/woodpecker/tag/ociImageTag Pipeline was successful Details
Version bump
2023-11-05 20:27:51 +01:00
.config Removed the Rust dependency and basically anything that isn't necessary to build the backend 2023-07-09 02:49:20 +02:00
.woodpecker Merge remote-tracking branch 'helm/add-helm-chart' into develop 2023-05-10 16:54:26 -07:00
dev postgres: revert to 12.2 version 2022-12-19 02:57:51 +02:00
packages Emoji ID in stream 2023-11-05 18:42:11 +01:00
scripts Removed calckey-js and removed channels 2023-07-20 22:57:13 +02:00
.dockerignore Removed assets and OpenAPI generators 2023-07-22 14:50:57 +02:00
.editorconfig Removed NodeInfo and WebFinger endpoints 2023-04-22 12:47:12 +02:00
.gitattributes MisskeyRoom (#5267) 2019-08-18 14:41:33 +09:00
.gitignore Removed assets and OpenAPI generators 2023-07-22 14:50:57 +02:00
.node-version Update '.node-version' 2023-05-31 02:36:19 +00: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
CODE_OF_CONDUCT.md calckey.org 2023-05-10 23:30:48 -07:00
COPYING Add Calckey copyright 2022-12-13 20:23:58 +01:00
Dockerfile Removed calckey-js and removed channels 2023-07-20 22:57:13 +02:00
LICENSE Use AGPLv3 2018-03-28 22:56:28 +09:00
README.md Fixed building instructions 2023-07-20 23:01:41 +02:00
docker-compose.yml precompile rust components 2023-06-22 16:00:28 -04:00
package.json Version bump 2023-11-05 20:27:51 +01:00
pnpm-lock.yaml Added hasRenotedBefore 2023-09-30 20:55:28 +02:00
pnpm-workspace.yaml Removed calckey-js and removed channels 2023-07-20 22:57:13 +02:00
title_float.svg refactor: rm .github folder 2022-12-16 10:44:09 -08:00

README.md

Calckey logo

This is a horribly broken fork of Calckey not intended to be run on its own.

no github badge status badge

Calc (the Calckey mascot) smoking a fat dart

About Calckey

Please see the upstream version if you seriously intend to run this project.

🌠 I wanna build this mess anyway

My primary way to build this project is using Podman and deploy as a container:

docker build -t calckey .

Continue reading if you want to build it natively.

🧑‍💻 Dependencies

  • 🐢 At least NodeJS v18.16.0 (v20 recommended)
    • Install with nvm
  • 🐘 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

🏗️ Build dependencies

  • 🦀 At least Rust v1.68.0
  • 🦬 C/C++ compiler & build tools
    • build-essential on Debian/Ubuntu Linux
    • base-devel on Arch Linux
  • 🐍 Python 3

👀 Get folder ready

git clone https://git.astolfo.cool/natty/calckey.git
cd calckey/

📩 Install dependencies

# nvm install 19 && nvm use 19
corepack enable
corepack prepare pnpm@latest --activate
pnpm i

Build

pnpm run build

Database

This setup assumes you already have a valid PostgreSQL database with a model corresponding to the Calckey version 14.0.0-RC3.

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.env to .config/docker.env if you're using Docker.

Running the server

pnpm run start

Web proxy

Caddy

  • Add the following block to your Caddyfile, replacing example.tld with your own domain:
example.tld {
    reverse_proxy http://127.0.0.1:3000
}
  • Reload your caddy configuration