diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE.md similarity index 85% rename from issue_template.md rename to .github/ISSUE_TEMPLATE.md index 4f952c5..2729a6b 100644 --- a/issue_template.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,11 +6,11 @@ about: When creating a bug report, please use the following template to provide **How to post a meaningful bug report** 1. *Read this whole template first.* -2. *Make sure you are on the right place:* - - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* - - *In doubt, ask here and we will figure it out together.* -3. *Delete these italic comments as you write over them below, and remove this guide.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* --- ### Describe the bug @@ -22,7 +22,7 @@ about: When creating a bug report, please use the following template to provide - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* - YunoHost version: x.x.x - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* -- Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* - If yes, please explain: - Using, or trying to install package version/branch: - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* @@ -31,13 +31,13 @@ about: When creating a bug report, please use the following template to provide - *If you performed a command from the CLI, the command itself is enough. For example:* ```sh - sudo yunohost app install misskey + sudo yunohost app install the_app ``` - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* 1. *Go to '...'* - 2. *Click on '....'* - 3. *Scroll down to '....'* + 2. *Click on '...'* + 3. *Scroll down to '...'* 4. *See error* ### Expected behavior diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/README.md b/README.md index 5952490..b42aa35 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,60 @@ + + # Misskey for YunoHost [![Integration level](https://dash.yunohost.org/integration/misskey.svg)](https://dash.yunohost.org/appci/app/misskey) ![](https://ci-apps.yunohost.org/ci/badges/misskey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/misskey.maintain.svg) -[![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)* > *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.* ## Overview -[Misskey](https://join.misskey.page/en/) is a forever evolving, sophisticated microblogging platform that support Fediverse. It provide another flavour to decentralised network. Why don't you take a short break from the hustle and bustle of the city, and dive into a new Internet? -**Shipped version:** 12.81.0 +Microblogging platform + +**Shipped version:** 12.82.0~ynh1 + + ## Screenshots -![](https://raw.githubusercontent.com/syuilo/misskey/develop/assets/ss/user.jpg) +![](./doc/screenshots/screenshot.jpg) -## Other instances to join +## Disclaimers / important information -* [Instances](https://join.misskey.page/en/wiki/instances/) +### Important points to read before installing -## Important points to read before installing +- *Misskey* require a dedicated root domain, eg. `misskey.domain.tld` +- *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 use of screen is rerecorded 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 page after 2-3 minutes. +- The first account created will be an admin user and will have all the admin rights. -1. **Misskey** require a dedicated **root domain**, eg. misskey.domain.tldYunoHost -2. **Misskey** can take quite some time to install( **more then 30 minutes** ). So take out some time and grab yourself a coffee. -3. If installing from command line use of **screen is rerecorded** to avoid disconnection.See below. -4. After installation first page can take time to load and may show timeout error. Give it time to make itself ready for you. **Refresh page after 2-3 minutes**. -5. The **first account created will be an admin user** and will have all the admin rights. - -#### Support - - * LDAP supported: **No** - * Can the app be used by multiple users?: **Yes** - -#### Using *screen* in case of disconnects +Using screen in case of disconnects +``` +sudo apt-get install screen +screen +sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh.git ``` -$ 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 +screen -d +screen -r ``` -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/misskey_ynh/issues - * App website: https://join.misskey.page - * Upstream app repository: https://github.com/syuilo/misskey - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://join.misskey.page +* Official user documentation: https://yunohost.org/apps +* Upstream app code repository: https://github.com/misskey-dev/misskey +* YunoHost documentation for this app: https://yunohost.org/app_misskey +* Report a bug: https://github.com/YunoHost-Apps/misskey_ynh/issues ## Developer info @@ -66,3 +66,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/test or sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..1e4bf20 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,66 @@ +# Misskey pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/misskey.svg)](https://dash.yunohost.org/appci/app/misskey) ![](https://ci-apps.yunohost.org/ci/badges/misskey.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/misskey.maintain.svg) +[![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 ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Misskey rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Platforme de Microblogging + +**Version incluse :** 12.82.0~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot.jpg) + +## Avertissements / informations importantes + +### Points importants à lire avant l'installation + +- *Misskey* nécessite un domaine racine dédié, par ex. `misskey.domain.tld` +- *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 + +* Site officiel de l'app : https://join.misskey.page +* Documentation officielle utilisateur : https://yunohost.org/apps +* Dépôt de code officiel de l'app : https://github.com/misskey-dev/misskey +* Documentation YunoHost pour cette app : https://yunohost.org/app_misskey +* Signaler un bug : https://github.com/YunoHost-Apps/misskey_ynh/issues + +## Informations pour les développeurs + +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. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug +ou +sudo yunohost app upgrade misskey -u https://github.com/YunoHost-Apps/misskey_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index ce8e10f..c1df627 100644 --- a/check_process +++ b/check_process @@ -10,7 +10,7 @@ setup_private=1 setup_public=1 upgrade=1 - #upgrade=0 from_commit=CommitHash + upgrade=1 from_commit=9ae6ee3553cd0fba8ed2d53755bf954106d51866 backup_restore=1 multi_instance=0 change_url=0 @@ -18,6 +18,6 @@ Email= Notification= ;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. + ; commit=9ae6ee3553cd0fba8ed2d53755bf954106d51866 + name=Merge pull request #4 manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& diff --git a/conf/app.src b/conf/app.src index ba373ff..d5c1be9 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/syuilo/misskey/archive/12.81.0.tar.gz -SOURCE_SUM=7534060ef796398650ca2f105bc51024ac1cefc6b1702dafd25101e7ccc6a929 +SOURCE_URL=https://github.com/misskey-dev/misskey/archive/refs/tags/12.82.0.tar.gz +SOURCE_SUM=16d9787a96ee4593c5ec97f38ad646cb348e8761781433f51897de683c063c72 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..2f4c44a --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,20 @@ +### Important points to read before installing + +- *Misskey* require a dedicated root domain, eg. `misskey.domain.tld` +- *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 use of screen is rerecorded 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 page after 2-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 +``` diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..60503e7 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,20 @@ +### Points importants à lire avant l'installation + +- *Misskey* nécessite un domaine racine dédié, par ex. `misskey.domain.tld` +- *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 +``` diff --git a/doc/screenshots/screenshot.jpg b/doc/screenshots/screenshot.jpg new file mode 100644 index 0000000..3ec595c Binary files /dev/null and b/doc/screenshots/screenshot.jpg differ diff --git a/manifest.json b/manifest.json index c4e38ab..d98cd18 100644 --- a/manifest.json +++ b/manifest.json @@ -6,13 +6,13 @@ "en": "Microblogging platform", "fr": "Platforme de Microblogging" }, - "version": "12.81.0~ynh1", + "version": "12.82.0~ynh1", "url": "https://join.misskey.page/en/", "upstream": { "license": "AGPL-3.0", "website": "https://join.misskey.page", "userdoc": "https://yunohost.org/apps", - "code": "https://github.com/syuilo/misskey" + "code": "https://github.com/misskey-dev/misskey" }, "license": "AGPL-3.0", "maintainer": { diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 6c28fc5..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how do you fix that problem* - -## PR Status -- [ ] Code finished. -- [ ] Tested with Package_check. -- [ ] Fix or enhancement tested. -- [ ] Upgrade from last version tested. -- [ ] Can be reviewed and tested. - -## Package_check results ---- -* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"* diff --git a/scripts/_common.sh b/scripts/_common.sh index 59495c0..5745215 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,7 +7,7 @@ MEMORY_NEEDED="2560" # dependencies used by the app -pkg_dependencies="build-essential python ffmpeg redis-server redis-tools postgresql postgresql-contrib" +pkg_dependencies="build-essential ffmpeg redis-server redis-tools postgresql postgresql-contrib" NODEJS_VERSION="12"