YunoHost-Apps/mongo-express_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mongo-express_ynh.git synced 2024-09-03 19:46:04 +02:00
Code Issues Activity Actions

Readme

Browse source
This commit is contained in:
Gérard Collin 2022-12-22 20:44:10 +01:00
parent 73521baf48
commit 88ecefb91a
2 changed files with 80 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
README.md
View file

@ -1,85 +1,79 @@
# Packaging 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)
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
* 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 # Mongo Express 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/mongo-express.svg)](https://dash.yunohost.org/appci/app/mongo-express) ![Working status](https://ci-apps.yunohost.org/ci/badges/mongo-express.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mongo-express.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Mongo Express with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mongo-express)
*[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 Mongo Express 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. Mongo Express is a Web-based MongoDB admin interface written with Node.js, Express and Bootstrap3.
You can as well install a Mongo database - version 4, 5 or 6 in your yunohost server if you want
### Features ### Features
- Optionally installs Mongo server
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Connect to multiple databases
- Laboris nisi ut aliquip ex ea commodo consequat ; - View/add/delete databases
- Duis aute irure dolor in reprehenderit in voluptate ; - View/add/rename/delete collections
- Velit esse cillum dolore eu fugiat nulla pariatur ; - View/add/update/delete documents
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Preview audio/video/image assets inline in collection view
- Nested and/or large objects are collapsible for easy overview
- Async on-demand loading of big document properties (>100KB default) to keep collection view fast
- GridFS support - add/get/delete incredibly large files
- Use BSON data types in documents
- Mobile / Responsive - Bootstrap 3 works passably on small screens when you're in a bind
- Connect and authenticate to individual databases
- Authenticate as admin to view all databases
- Database blacklist/whitelist
- Custom CA and CA validation disabling
- Supports replica sets
**Shipped version:** 1.0~ynh1 **Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Mongo Express](./doc/screenshots/databases-view.png)
![Screenshot of Mongo Express](./doc/screenshots/collection-view.png)
![Screenshot of Mongo Express](./doc/screenshots/document-edit.png)
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to): * For now, any user that can log to your server will have admin access to all your Mongo databases !
* requiring a full dedicated domain ? * Single-sign on or LDAP are not integrated
* architectures not supported ? * It's strongly recommanded you don't enable public access to the application
* not-working single-sign on or LDAP integration ?
* 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: * It doesn't backup Mongo databases
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * As mongo-express doesn't require any database by itself, it doesn't backup or restore any of them
* how to configure / administrate the application if it ain't obvious * However, yYou can view / edit other applications databases with Mongo-Express
* upgrade process / specificities / things to be aware of ? * It will just reinstall the Mongo server if you installed it with this script
* security considerations ? * Any yunohost applications using Mongo databases should manage the backup and restore
## Documentation and resources ## Documentation and resources
* Official app website: <https://example.com> * Official app website: <https://github.com/mongo-express/mongo-express>
* Official user documentation: <https://yunohost.org/apps> * Upstream app code repository: <https://github.com/mongo-express/mongo-express>
* Official admin documentation: <https://yunohost.org/packaging_apps> * YunoHost documentation for this app: <https://yunohost.org/app_mongo-express>
* Upstream app code repository: <https://some.forge.com/example/example> * Report a bug: <https://github.com/YunoHost-Apps/mongo-express_ynh/issues>
* YunoHost documentation for this app: <https://yunohost.org/app_example>
* Report a bug: <https://github.com/YunoHost-Apps/example_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/mongo-express_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/mongo-express_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 mongo-express -u https://github.com/YunoHost-Apps/mongo-express_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

74
README_fr.md
View file

@ -3,71 +3,77 @@ 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.
--> -->
# Exemple d'app pour YunoHost # Mongo Express 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/mongo-express.svg)](https://dash.yunohost.org/appci/app/mongo-express) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mongo-express.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mongo-express.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Mongo Express avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mongo-express)
*[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 Mongo Express 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. Mongo Express is a Web-based MongoDB admin interface written with Node.js, Express and Bootstrap3.
You can as well install a Mongo database - version 4, 5 or 6 in your yunohost server if you want
### Features ### Features
- Optionally installs Mongo server
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Connect to multiple databases
- Laboris nisi ut aliquip ex ea commodo consequat ; - View/add/delete databases
- Duis aute irure dolor in reprehenderit in voluptate ; - View/add/rename/delete collections
- Velit esse cillum dolore eu fugiat nulla pariatur ; - View/add/update/delete documents
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Preview audio/video/image assets inline in collection view
- Nested and/or large objects are collapsible for easy overview
- Async on-demand loading of big document properties (>100KB default) to keep collection view fast
- GridFS support - add/get/delete incredibly large files
- Use BSON data types in documents
- Mobile / Responsive - Bootstrap 3 works passably on small screens when you're in a bind
- Connect and authenticate to individual databases
- Authenticate as admin to view all databases
- Database blacklist/whitelist
- Custom CA and CA validation disabling
- Supports replica sets
**Version incluse :** 1.0~ynh1 **Version incluse :** 1.0~ynh1
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d'écran de Mongo Express](./doc/screenshots/databases-view.png)
![Capture d'écran de Mongo Express](./doc/screenshots/collection-view.png)
![Capture d'écran de Mongo Express](./doc/screenshots/document-edit.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): * For now, any user that can log to your server will have admin access to all your Mongo databases !
* requiring a full dedicated domain ? * Single-sign on or LDAP are not integrated
* architectures not supported ? * It's strongly recommanded you don't enable public access to the application
* not-working single-sign on or LDAP integration ?
* 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: * It doesn't backup Mongo databases
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) * As mongo-express doesn't require any database by itself, it doesn't backup or restore any of them
* how to configure / administrate the application if it ain't obvious * However, yYou can view / edit other applications databases with Mongo-Express
* upgrade process / specificities / things to be aware of ? * It will just reinstall the Mongo server if you installed it with this script
* security considerations ? * Any yunohost applications using Mongo databases should manage the backup and restore
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://example.com> * Site officiel de l'app : <https://github.com/mongo-express/mongo-express>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Dépôt de code officiel de l'app : <https://github.com/mongo-express/mongo-express>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Documentation YunoHost pour cette app : <https://yunohost.org/app_mongo-express>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * Signaler un bug : <https://github.com/YunoHost-Apps/mongo-express_ynh/issues>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_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/mongo-express_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/mongo-express_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 mongo-express -u https://github.com/YunoHost-Apps/mongo-express_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>