hippofish/README.md

122 lines
3.5 KiB
Markdown
Raw Normal View History

2021-02-07 03:43:55 +01:00
<div align="center">
2022-07-19 02:39:19 +02:00
<a href="https://stop.voring.me/">
2022-08-09 00:10:31 +02:00
<img src="./.github/title_float.svg" alt="Calckey logo" style="border-radius:50%" width="400"/>
</a>
2022-07-19 07:07:59 +02:00
2022-07-19 02:39:19 +02:00
**🌎 **[Calckey](https://stop.voring.me/)** is an open source, decentralized social media platform that's free forever! 🚀**
2022-07-19 07:07:59 +02:00
2021-02-07 03:43:55 +01:00
</div>
2021-11-20 10:21:18 +01:00
<div>
2021-03-24 03:57:12 +01:00
2022-07-19 01:51:31 +02:00
<img src="https://pool.jortage.com/voringme/misskey/e7cd2a17-8b23-4e1e-b5cf-709480c623e2.png" align="right" height="320px"/>
2018-09-12 22:35:11 +02:00
2022-08-08 08:07:22 +02:00
# ✨ 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:
2022-09-14 02:21:23 +02:00
- Improved UI/UX (especially on mobile)
- Improved notifications
- Improved instance security
2022-08-08 08:07:22 +02:00
- Recommended Instances timeline
2022-10-28 00:30:26 +02:00
- OCR image captioning
2022-09-14 02:21:23 +02:00
- New and improved Groups
2022-11-09 10:04:30 +01:00
- Better intro tutorial
2022-08-08 08:07:22 +02:00
- Many more user and admin settings
2022-09-14 02:21:23 +02:00
- [So much more!](./CALCKEY.md)
2019-02-05 16:13:31 +01:00
2021-11-20 10:21:18 +01:00
</div>
2017-01-23 10:25:52 +01:00
2021-11-20 10:21:18 +01:00
<div style="clear: both;"></div>
2018-04-15 22:04:56 +02:00
2022-08-10 08:14:51 +02:00
# 🥂 Links
2022-11-07 00:06:44 +01:00
- 💸 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>
2022-08-10 08:14:51 +02:00
2022-11-04 22:38:38 +01:00
# 🌠 Getting started
2022-07-28 04:36:58 +02:00
2022-11-04 22:38:38 +01:00
This guide will work for both **starting from scratch** and **migrating from Misskey**.
2022-11-04 22:56:30 +01:00
## 📦 Dependencies
2022-11-04 22:46:51 +01:00
2022-11-06 03:43:41 +01:00
- At least 🐢 NodeJS v16.15.0 (v18.12.1 recommended)
2022-11-04 22:38:38 +01:00
> ⚠️ NodeJS v19 is not supported as of right now because of [this issue](https://github.com/nodejs/node-gyp/issues/2757).
2022-08-10 09:50:50 +02:00
2022-11-04 22:47:18 +01:00
- 🧶 At least Yarn v3
2022-11-04 22:46:51 +01:00
- 🐘 At least PostgreSQL v12
- 🍱 At least Redis v6 (v7 recommended)
2022-11-05 02:48:45 +01:00
- 🛰️ (Optional, for non-Docker) pm2
2022-08-08 08:07:22 +02:00
## 👀 Get folder ready
2022-07-27 20:31:56 +02:00
2022-07-19 20:59:20 +02:00
```sh
2022-07-19 02:36:11 +02:00
git clone https://codeberg.org/thatonecalculator/calckey.git
cd calckey/
2022-07-24 08:15:09 +02:00
# git checkout main # if you want only stable versions
2022-07-27 20:31:56 +02:00
```
2022-10-27 10:01:27 +02:00
## 📩 Install dependencies
```sh
2022-11-04 22:49:06 +01:00
# nvm install 18 && nvm alias default 18 && nvm use 18
2022-10-27 10:01:27 +02:00
corepack enable
```
## 💅 Customize
2022-08-10 08:18:00 +02:00
- 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`.
2022-11-04 22:38:38 +01:00
## 🚚 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
```
2022-11-04 22:43:00 +01:00
## 🍀 NGINX
Read <https://misskey-hub.net/en/docs/admin/nginx.html>
2022-08-08 08:07:22 +02:00
## 🚀 Build and launch!
2022-07-27 20:31:56 +02:00
2022-11-04 22:38:38 +01:00
### 🐢 NodeJS
#### `git pull` and run these steps to update Calckey in the future!
2022-07-27 20:31:56 +02:00
```sh
# git pull
yarn install
2022-08-10 05:06:49 +02:00
NODE_ENV=production yarn run build && yarn run migrate
2022-11-05 02:48:45 +01:00
pm2 start "NODE_ENV=production yarn start" --name Calckey
2022-07-19 07:07:59 +02:00
```
2022-07-29 03:25:02 +02:00
2022-11-04 22:38:38 +01:00
### 🐋 Prebuilt Docker image
2022-08-08 08:07:22 +02:00
```sh
2022-11-04 22:38:38 +01:00
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
2022-08-08 08:07:22 +02:00
```
2022-11-09 10:52:23 +01:00
## 😉 Tips & Tricks
- To generate ServiceWorker keys, run `npx web-push generate-vapid-keys`
- I'd ***strongly*** recommend against using CloudFlare, but if you do, make sure to turn code minification off.