1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/misskey_ynh.git synced 2024-09-03 19:46:03 +02:00

Auto-update READMEs

This commit is contained in:
yunohost-bot 2024-03-27 11:31:59 +00:00 committed by autoreadme_webhook
parent d0164b39a8
commit 50a0a8c857
3 changed files with 25 additions and 67 deletions

4
ALL_README.md Normal file
View file

@ -0,0 +1,4 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lire le README en français](README_fr.md)

View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
@ -9,45 +9,22 @@ It shall NOT be edited by hand.
[![Install Misskey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey) [![Install Misskey with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey)
*[Lire ce readme en français.](./README_fr.md)* *[Read this README is other languages.](./ALL_README.md)*
> *This package allows you to install Misskey quickly and simply on a YunoHost server. > *This package allows you to install Misskey quickly and simply on a YunoHost server.*
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview ## Overview
Misskey is a decentralized microblogging platform. Since it exists within the Fediverse (a universe where various social media platforms are organized), it is mutually linked with other social media platforms. Misskey is a decentralized microblogging platform. Since it exists within the Fediverse (a universe where various social media platforms are organized), it is mutually linked with other social media platforms.
**Shipped version:** 12.119.2~ynh1 **Shipped version:** 12.119.2~ynh1
## Screenshots ## Screenshots
![Screenshot of Misskey](./doc/screenshots/screenshot-desktop.png) ![Screenshot of Misskey](./doc/screenshots/screenshot-desktop.png)
## Disclaimers / important information
### Important points to read before installing
- *Misskey* requires a dedicated root domain, e.g. `misskey.domain.tld`
- Due to Cypress dependency, *Misskey* only works on 64-bit CPU machines.
- *Misskey* 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/misskey_ynh.git
```
Recover after disconnect:
```
screen -d
screen -r
```
## Documentation and resources ## Documentation and resources
- Official app website: <https://misskey-hub.net/> - Official app website: <https://misskey-hub.net/>
@ -57,9 +34,9 @@ screen -r
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the `testing` branch, please proceed like that:
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug

View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator Nota bene: ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# Misskey pour YunoHost # Misskey pour YunoHost
@ -9,56 +9,33 @@ It shall NOT be edited by hand.
[![Installer Misskey avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey) [![Installer Misskey avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=misskey)
*[Read this readme in english.](./README.md)* *[Lire le README dans d'autres langues.](./ALL_README.md)*
> *Ce package vous permet dinstaller Misskey rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet dinstaller Misskey rapidement et simplement sur un serveur YunoHost.*
Si vous navez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment linstaller et en profiter.* > *Si vous navez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment linstaller et en profiter.*
## Vue densemble ## Vue densemble
Misskey est une plateforme de microblogging décentralisée. Puisqu'il existe au sein du Fediverse (un univers où diverses plateformes de médias sociaux sont organisées), il est mutuellement lié à d'autres plateformes de médias sociaux. Misskey est une plateforme de microblogging décentralisée. Puisqu'il existe au sein du Fediverse (un univers où diverses plateformes de médias sociaux sont organisées), il est mutuellement lié à d'autres plateformes de médias sociaux.
**Version incluse :** 12.119.2~ynh1
**Version incluse:** 12.119.2~ynh1
## Captures décran ## Captures décran
![Capture décran de Misskey](./doc/screenshots/screenshot-desktop.png) ![Capture décran de Misskey](./doc/screenshots/screenshot-desktop.png)
## Avertissements / informations importantes
### Points importants à lire avant l'installation
- *Misskey* nécessite un domaine racine dédié, par ex. `misskey.domain.tld`
- En raison de la dépendance de Cypress, *Misskey* ne fonctionne que sur les machines à processeur 64 bits.
- *Misskey* peut prendre un certain temps à installer (plus de 30 minutes). Alors prenez un peu de temps et prenez un café.
- Si l'installation à partir de la ligne de commande, l'utilisation de l'écran est réenregistrée pour éviter la déconnexion. Voir ci-dessous.
- Après l'installation, la première page peut prendre du temps à charger et peut afficher une erreur de délai d'attente. Donnez-lui le temps de se préparer pour vous. Actualiser la page après 2-3 minutes.
- Le premier compte créé sera un utilisateur administrateur et disposera de tous les droits d'administrateur.
Utiliser *screen* en cas de déconnexion
```
sudo apt-get install screen
screen
sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh.git
```
Récupérer après déconnexion :
```
screen -d
screen -r
```
## Documentations et ressources ## Documentations et ressources
- Site officiel de lapp : <https://misskey-hub.net/> - Site officiel de lapp: <https://misskey-hub.net/>
- Dépôt de code officiel de lapp : <https://github.com/misskey-dev/misskey> - Dépôt de code officiel de lapp: <https://github.com/misskey-dev/misskey>
- YunoHost Store : <https://apps.yunohost.org/app/misskey> - YunoHost Store: <https://apps.yunohost.org/app/misskey>
- Signaler un bug : <https://github.com/YunoHost-Apps/misskey_ynh/issues> - Signaler un bug: <https://github.com/YunoHost-Apps/misskey_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing). Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/misskey_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche `testing`, procédez comme suit:
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug
@ -66,4 +43,4 @@ ou
sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug
``` ```
**Plus dinfos sur le packaging dapplications :** <https://yunohost.org/packaging_apps> **Plus dinfos sur le packaging dapplications:** <https://yunohost.org/packaging_apps>