calckey/README.md

172 lines
7.5 KiB
Markdown
Raw Normal View History

2022-12-16 17:35:54 +00:00
<div align="center">
<a href="https://i.calckey.cloud/">
2022-12-16 18:44:09 +00:00
<img src="./title_float.svg" alt="Calckey logo" style="border-radius:50%" width="400"/>
</a>
2022-07-19 05:07:59 +00:00
**🌎 **[Calckey](https://i.calckey.cloud/)** is an open source, decentralized social media platform that's free forever! 🚀**
2022-07-19 05:07:59 +00:00
2023-01-03 18:42:26 +00:00
[![no-github-badge](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page/)
2022-12-18 18:12:24 +00:00
[![status-badge](https://ci.codeberg.org/api/badges/calckey/calckey/status.svg)](https://ci.codeberg.org/calckey/calckey)
2022-12-16 21:30:58 +00:00
[![liberapay-badge](https://img.shields.io/liberapay/receives/ThatOneCalculator?logo=liberapay)](https://liberapay.com/ThatOneCalculator)
2022-12-17 18:17:39 +00:00
[![translate-badge](https://hosted.weblate.org/widgets/calckey/-/svg-badge.svg)](https://hosted.weblate.org/engage/calckey/)
2022-12-16 21:30:58 +00:00
[![docker-badge](https://img.shields.io/docker/pulls/thatonecalculator/calckey?logo=docker)](https://hub.docker.com/r/thatonecalculator/calckey)
2023-01-04 01:38:07 +00:00
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md)
2022-12-18 18:12:24 +00:00
[![codeberg-badge](https://custom-icon-badges.demolab.com/badge/hosted%20on-codeberg-blue.svg?logo=codeberg&logoColor=white)](https://codeberg.org/calckey/calckey/)
2022-12-16 17:35:54 +00:00
2021-02-07 02:43:55 +00:00
</div>
2021-11-20 09:21:18 +00:00
<div>
2021-03-24 02:57:12 +00:00
2022-11-16 04:25:00 +00:00
<img src="https://pool.jortage.com/voringme/misskey/e7cd2a17-8b23-4e1e-b5cf-709480c623e2.png" align="right" height="320px" alt="Calc (the Calckey mascot) smoking a fat dart"/>
2018-09-12 20:35:11 +00:00
2022-08-08 06:07:22 +00: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!
2022-08-08 06:07:22 +00:00
- 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 00:21:23 +00:00
- Improved UI/UX (especially on mobile)
- Improved notifications
2022-12-12 01:53:09 +00:00
- Fediverse account migration
2022-09-14 00:21:23 +00:00
- Improved instance security
2022-11-30 02:15:57 +00:00
- Improved accessibility
2022-08-08 06:07:22 +00:00
- Recommended Instances timeline
2022-10-27 22:30:26 +00:00
- OCR image captioning
2022-09-14 00:21:23 +00:00
- New and improved Groups
2022-11-09 09:04:30 +00:00
- Better intro tutorial
2022-08-08 06:07:22 +00:00
- Many more user and admin settings
2022-09-14 00:21:23 +00:00
- [So much more!](./CALCKEY.md)
2019-02-05 15:13:31 +00:00
2021-11-20 09:21:18 +00:00
</div>
2017-01-23 09:25:52 +00:00
2021-11-20 09:21:18 +00:00
<div style="clear: both;"></div>
2018-04-15 20:04:56 +00:00
2022-08-10 06:14:51 +00:00
# 🥂 Links
2022-11-19 07:20:18 +00:00
- 💸 Liberapay: <https://liberapay.com/ThatOneCalculator>
- Donate publicly to get your name on the Patron list!
- 🚢 Flagship instance: <https://i.calckey.cloud>
- 📣 Official account: <https://i.calckey.cloud/@calckey>
2022-11-06 23:06:44 +00:00
- 💁 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-11-15 06:24:36 +00:00
- 🐋 Docker Hub: <https://hub.docker.com/r/thatonecalculator/calckey>
2022-12-17 18:21:17 +00:00
- ✍️ Weblate: <https://hosted.weblate.org/engage/calckey/>
2023-01-02 15:59:31 +00:00
- 📦 Yunohost: <https://github.com/YunoHost-Apps/calckey_ynh>
2022-08-10 06:14:51 +00:00
2022-11-04 21:38:38 +00:00
# 🌠 Getting started
2022-07-28 02:36:58 +00:00
2022-11-04 21:38:38 +00:00
This guide will work for both **starting from scratch** and **migrating from Misskey**.
2023-01-05 04:11:34 +00:00
[![Install Calckey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=calckey)
2023-01-02 15:59:31 +00:00
## 🧑‍💻 Dependencies
2022-11-04 21:46:51 +00:00
2022-12-06 23:27:59 +00:00
- 🐢 At least [NodeJS](https://nodejs.org/en/) v18.12.1 (v19 recommended)
2022-11-27 19:55:45 +00:00
- Install with [nvm](https://github.com/nvm-sh/nvm)
2022-11-09 21:38:27 +00:00
- 🐘 At least [PostgreSQL](https://www.postgresql.org/) v12
2022-12-07 04:42:48 +00:00
- 🍱 At least [Redis](https://redis.io/) v6 (v7 recommend)
2022-11-27 20:04:08 +00:00
### 😗 Optional dependencies
2022-12-17 18:21:17 +00:00
- [FFmpeg](https://ffmpeg.org/) for video transcoding
- [ElasticSearch](https://www.elastic.co/elasticsearch/) for full-text search
2022-11-27 20:04:08 +00:00
- OpenSearch/Sonic are not supported as of right now
2022-12-17 18:21:17 +00:00
- Management (choose one of the following)
2022-11-27 20:04:08 +00:00
- 🛰️ [pm2](https://pm2.io/)
- 🐳 [Docker](https://docker.com)
2022-12-17 18:21:17 +00:00
- Service manager (systemd, openrc, etc)
2022-11-05 01:48:45 +00:00
### 🏗️ Build dependencies
- 🦬 C/C++ compiler & build tools
- `build-essential` on Debian/Ubuntu Linux
- `base-devel` on Arch Linux
2022-11-27 19:55:45 +00:00
- 🐍 [Python 3](https://www.python.org/)
2022-08-08 06:07:22 +00:00
## 👀 Get folder ready
2022-07-27 18:31:56 +00:00
2022-07-19 18:59:20 +00:00
```sh
2022-12-18 18:12:24 +00:00
git clone https://codeberg.org/calckey/calckey.git
2022-07-19 00:36:11 +00:00
cd calckey/
2022-07-24 06:15:09 +00:00
# git checkout main # if you want only stable versions
2022-07-27 18:31:56 +00:00
```
2022-10-27 08:01:27 +00:00
## 📩 Install dependencies
```sh
2023-01-03 23:56:32 +00:00
# nvm install 19 && nvm use 19
2022-10-27 08:01:27 +00:00
corepack enable
```
## 🐘 Create database
Assuming you set up PostgreSQL correctly, all you have to run is:
```sh
psql postgres -c "create database calckey with encoding = 'UTF8';"
```
## 💅 Customize
2022-11-30 18:51:12 +00:00
- To add custom CSS for all users, edit `./custom/assets/instance.css`.
- To add static assets (such as images for the splash screen), place them in the `./custom/assets/` directory. They'll then be available on `https://yourinstance.tld/static-assets/filename.ext`.
2022-11-30 18:51:12 +00:00
- To add custom locales, place them in the `./custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: `en-FOO.yml`)
2022-11-15 08:23:53 +00:00
- To update custom assets without rebuilding, just run `yarn run gulp`.
2022-11-13 19:32:17 +00:00
## 🧑‍🔬 Configuring a new instance
- 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.
2022-11-04 21:38:38 +00:00
## 🚚 Migrating from Misskey to Calckey
> ⚠️ Because of their changes, migrating from Foundkey is not supported.
```sh
2022-11-13 19:32:17 +00:00
cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, add `docker.env` if you use Docker
2022-11-04 21:38:38 +00:00
cp -r ../misskey/files . # if you don't use object storage
```
2022-11-04 21:43:00 +00:00
## 🍀 NGINX
- Run `sudo cp ./calckey.nginx.conf /etc/nginx/sites-available/ && cd /etc/nginx/sites-available/`
- Edit `calckey.nginx.conf` to reflect your instance properly
- Run `sudo cp ./calckey.nginx.conf ../sites-enabled/`
- Run `sudo nginx -t` to validate that the config is valid, then restart the NGINX service.
2022-11-09 21:38:27 +00:00
</details>
2022-11-04 21:43:00 +00:00
2022-08-08 06:07:22 +00:00
## 🚀 Build and launch!
2022-07-27 18:31:56 +00:00
2022-11-27 20:04:08 +00:00
### 🐢 NodeJS + pm2
2022-11-04 21:38:38 +00:00
#### `git pull` and run these steps to update Calckey in the future!
2022-07-27 18:31:56 +00:00
```sh
# git pull
yarn install
2022-12-14 17:09:58 +00:00
NODE_ENV=production yarn run rebuild && yarn run migrate
2022-11-05 01:48:45 +00:00
pm2 start "NODE_ENV=production yarn start" --name Calckey
2022-07-19 05:07:59 +00:00
```
2022-07-29 01:25:02 +00:00
### 🐋 Docker
2022-08-08 06:07:22 +00:00
2022-12-13 04:48:30 +00:00
[How to run Calckey with Docker](./docker-README.md).
2022-11-04 21:38:38 +00:00
2022-11-09 09:52:23 +00:00
## 😉 Tips & Tricks
2022-11-16 04:18:04 +00:00
- When editing the config file, please don't fill out the settings at the bottom. They're designed *only* for managed hosting, not self hosting. Those settings are much better off being set in Calckey's control panel.
2022-11-16 04:19:53 +00:00
- Port 3000 (used in the default config) might be already used on your server for something else. To find an open port for Calckey, run `for p in $(seq 3000 4000); do ss -tlnH | tr -s ' ' | cut -d" " -sf4 | grep -q "${p}$" || echo "${p}"; done | head -n 1`
2022-11-24 01:55:38 +00:00
- I'd recommend you use a S3 Bucket/CDN for Object Storage, especially if you use Docker.
- I'd ***strongly*** recommend against using CloudFlare, but if you do, make sure to turn code minification off.
2022-11-09 21:17:39 +00:00
- For push notifications, run `npx web-push generate-vapid-keys`, the put the public and private keys into Control Panel > General > ServiceWorker.
- For translations, make a [DeepL](https://deepl.com) account and generate an API key, then put it into Control Panel > General > DeepL Translation.
2022-11-15 00:53:08 +00:00
- To add another admin account:
- Go to the user's page > 3 Dots > About > Moderation > turn on "Moderator"
- Go back to Overview > click the clipboard icon next to the ID
- Run `psql -d calckey` (or whatever the database name is)
- Run `UPDATE "user" SET "isAdmin" = true WHERE id='999999';` (replace `999999` with the copied ID)
- Have the new admin log out and log back in