Calckey logo **๐ŸŒŽ **[Calckey](https://stop.voring.me/)** is an open source, decentralized social media platform that's free forever! ๐Ÿš€**
# โœจ 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](./CALCKEY.md)** 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 - Many more user and admin settings - [So much more!](./CALCKEY.md)
# ๐Ÿฅ‚ Links - ๐Ÿ’ธ Liberapay: - ๐Ÿ’ Matrix support room: - ๐Ÿ“œ Instance list: - ๐Ÿ“– JoinFediverse Wiki: # ๐ŸŒ  Getting started This guide will work for both **starting from scratch** and **migrating from Misskey**. ## ๐Ÿ“ฆ Dependencies - At least ๐Ÿข NodeJS v16.15.0 (v18.12.1 recommended) > โš ๏ธ NodeJS v19 is not supported as of right now because of [this issue](https://github.com/nodejs/node-gyp/issues/2757). - ๐Ÿงถ At least Yarn v3 - ๐Ÿ˜ At least PostgreSQL v12 - ๐Ÿฑ At least Redis v6 (v7 recommended) - ๐Ÿ›ฐ๏ธ (Optional, for non-Docker) pm2 ## ๐Ÿ‘€ Get folder ready ```sh git clone https://codeberg.org/thatonecalculator/calckey.git cd calckey/ # git checkout main # if you want only stable versions ``` ## ๐Ÿ“ฉ Install dependencies ```sh # nvm install 18 && nvm alias default 18 && nvm use 18 corepack enable ``` ## ๐Ÿ’… 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`. ## ๐Ÿšš Migrating from Misskey to Calckey > โš ๏ธ Because of their changes, migrating from Foundkey is not supported. ```sh cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, replace `default.yml` with `docker.yml` if you use docker cp -r ../misskey/files . # if you don't use object storage ``` ## ๐Ÿ€ NGINX Read ## ๐Ÿš€ Build and launch! ### ๐Ÿข NodeJS #### `git pull` and run these steps to update Calckey in the future! ```sh # 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 ```sh docker pull thatonecalculator:calckey docker up -d ``` ### ๐Ÿณ Docker Compose ```sh sudo docker compose build sudo docker-compose run --rm web yarn run init sudo docker compose up -d ```