mirror of https://github.com/YunoHost-Apps/calckey_ynh.git synced 2024-09-03 18:16:18 +02:00

Calcket package for YunoHost

calckey

Find a file

oufmilo 84ae1d962d Update tests.toml		2023-02-20 14:38:12 +01:00
.github	Fix updater.sh	2023-02-06 09:24:58 +01:00
conf	Update systemd.service	2023-02-20 02:03:15 +01:00
doc	First commit V2	2023-02-15 01:03:33 +01:00
scripts	Update upgrade	2023-02-20 13:10:05 +01:00
LICENSE	Update LICENSE	2022-12-22 12:15:07 +01:00
manifest.toml	Fix	2023-02-15 01:46:23 +01:00
README.md	Auto-update README	2023-02-06 08:16:48 +00:00
README_fr.md	Auto-update README	2023-02-06 08:16:48 +00:00
tests.toml	Update tests.toml	2023-02-20 14:38:12 +01:00

README.md

Calckey for YunoHost

Lire ce readme en français.

This package allows you to install Calckey quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

A greatly enhanced fork of Misskey with better UI/UX, security, features, and more! https://i.calckey.cloud/

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.

Shipped version: 13.1.2~ynh1

Demo: https://i.calckey.cloud/

Screenshots

Disclaimers / important information

Important points to read before installing

Calckey requires a dedicated root domain, e.g. Calckey.domain.tld
Due to Cypress dependency, Calckey only works on 64-bit CPU machines.
Calckey can take quite some time to install (more then 30 minutes). So take out some time and grab yourself a coffee.
If installing from command line, using screen is recommended to avoid disconnection. See below.
After installation, first page can take time to load and may show timeout error. Give it time to make itself ready for you. Refresh the page after 2 or 3 minutes.
The first account created will be an admin user and will have all the admin rights.

Using screen in case of disconnects

sudo apt-get install screen
screen
sudo yunohost app install https://github.com/YunoHost-Apps/Calckey_ynh.git

Recover after disconnect:

screen -d
screen -r

Documentation and resources

Official app website: https://i.calckey.cloud/
Upstream app code repository: https://codeberg.org/calckey/calckey
YunoHost documentation for this app: https://yunohost.org/app_calckey
Report a bug: https://github.com/YunoHost-Apps/calckey_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/calckey_ynh/tree/testing --debug
or
sudo yunohost app upgrade calckey -u https://github.com/YunoHost-Apps/calckey_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps