calckey/README.md

118 lines
3.3 KiB
Markdown

<div align="center">
<a href="https://stop.voring.me/">
<img src="./.github/title_float.svg" alt="Calckey logo" style="border-radius:50%" width="400"/>
</a>
**🌎 **[Calckey](https://stop.voring.me/)** is an open source, decentralized social media platform that's free forever! 🚀**
</div>
<div>
<img src="https://pool.jortage.com/voringme/misskey/e7cd2a17-8b23-4e1e-b5cf-709480c623e2.png" align="right" height="320px"/>
# ✨ 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)
</div>
<div style="clear: both;"></div>
# 🥂 Links
- 💸 Liberapay: <https://liberapay.com/ThatOneCalculator>
- 💁 Matrix support room: <https://matrix.to/#/#calckey:matrix.fedibird.com>
- 📜 Instance list: <https://calckey.fediverse.observer/list>
- 📖 JoinFediverse Wiki: <https://joinfediverse.wiki/What_is_Calckey%3F>
# 🌠 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
yarn set version berry
```
## 💅 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 <https://misskey-hub.net/en/docs/admin/nginx.html>
## 🚀 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
```