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

Auto-update README

This commit is contained in:
yunohost-bot 2022-06-04 08:53:36 +00:00
parent f0a5f48d77
commit 8ca6aee6a3
2 changed files with 58 additions and 75 deletions

View file

@ -1,84 +1,70 @@
# Packaging your an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.json` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Add a `LICENSE` file for the package.
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be 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 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.
--> -->
# Example app for YunoHost # Photoprism for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/photoprism.svg)](https://dash.yunohost.org/appci/app/photoprism) ![Working status](https://ci-apps.yunohost.org/ci/badges/photoprism.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/photoprism.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Photoprism with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=photoprism)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install Photoprism 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
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats
- Laboris nisi ut aliquip ex ea commodo consequat ; - Easily find specific pictures using powerful search filters
- Duis aute irure dolor in reprehenderit in voluptate ; - Includes four high-resolution world maps to bring back the memories of your favorite trips
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Play Live Photos™ by hovering over them in albums and search results
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Recognizes the faces of your family and friends
- Automatic classification of pictures based on their content and location
**Shipped version:** 1.0~ynh1 **Shipped version:** 2022.28.05~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo-fr.photoprism.app
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Photoprism](./doc/screenshots/photoprism.jpg)
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to): * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * Not tested yet with AMD architecture
* architectures not supported ? * Photoprism currently supports only one user. OIDC should be supported within a few months
* not-working single-sign on or LDAP integration ? * Photoprism requires an important amount of RAM and disk to install or to work properly
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as: * At first install, you'll be prompted for credentials
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * Username is "admin"
* how to configure / administrate the application if it ain't obvious * Password is the password you have set during the installation
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentation and resources ## Documentation and resources
* Official app website: <https://example.com> * Official app website: <photoprism.app>
* Official user documentation: <https://yunohost.org/apps> * Official user documentation: <https://docs.photoprism.app/user-guide/>
* Official admin documentation: <https://yunohost.org/packaging_apps> * Official admin documentation: <https://docs.photoprism.app/developer-guide/>
* Upstream app code repository: <https://some.forge.com/example/example> * Upstream app code repository: <https://github.com/photoprism/photoprism>
* YunoHost documentation for this app: <https://yunohost.org/app_example> * YunoHost documentation for this app: <https://yunohost.org/app_photoprism>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues> * Report a bug: <https://github.com/YunoHost-Apps/photoprism_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/photoprism_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/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/photoprism_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade photoprism -u https://github.com/YunoHost-Apps/photoprism_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

View file

@ -3,71 +3,68 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Example app pour YunoHost # Photoprism pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/photoprism.svg)](https://dash.yunohost.org/appci/app/photoprism) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/photoprism.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/photoprism.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Photoprism avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=photoprism)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Photoprism 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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats
- Laboris nisi ut aliquip ex ea commodo consequat ; - Easily find specific pictures using powerful search filters
- Duis aute irure dolor in reprehenderit in voluptate ; - Includes four high-resolution world maps to bring back the memories of your favorite trips
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Play Live Photos™ by hovering over them in albums and search results
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Recognizes the faces of your family and friends
- Automatic classification of pictures based on their content and location
**Version incluse :** 1.0~ynh1 **Version incluse :** 2022.28.05~ynh1
**Démo :** https://demo.example.com **Démo :** https://demo-fr.photoprism.app
## Captures d'écran ## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d'écran de Photoprism](./doc/screenshots/photoprism.jpg)
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * Not tested yet with AMD architecture
* architectures not supported ? * Photoprism currently supports only one user. OIDC should be supported within a few months
* not-working single-sign on or LDAP integration ? * Photoprism requires an important amount of RAM and disk to install or to work properly
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as: * At first install, you'll be prompted for credentials
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * Username is "admin"
* how to configure / administrate the application if it ain't obvious * Password is the password you have set during the installation
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://example.com> * Site officiel de l'app : <photoprism.app>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Documentation officielle utilisateur : <https://docs.photoprism.app/user-guide/>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Documentation officielle de l'admin : <https://docs.photoprism.app/developer-guide/>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * Dépôt de code officiel de l'app : <https://github.com/photoprism/photoprism>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> * Documentation YunoHost pour cette app : <https://yunohost.org/app_photoprism>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues> * Signaler un bug : <https://github.com/YunoHost-Apps/photoprism_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/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/photoprism_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/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/photoprism_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade photoprism -u https://github.com/YunoHost-Apps/photoprism_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>