mirror of
https://github.com/YunoHost-Apps/mongo-express_ynh.git
synced 2024-09-03 19:46:04 +02:00
Readme
This commit is contained in:
Gérard Collin
parent
73521baf48
commit
88ecefb91a
2 changed files with 80 additions and 80 deletions
86
README.md
86
README.md
|
|
@ -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
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Mongo Express for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/mongo-express)  
|
||||
[](https://install-app.yunohost.org/?app=mongo-express)
|
||||
|
||||
*[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.*
|
||||
|
||||
## 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
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
- Optionally installs Mongo server
|
||||
- Connect to multiple databases
|
||||
- View/add/delete databases
|
||||
- View/add/rename/delete collections
|
||||
- View/add/update/delete documents
|
||||
- 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
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
* For now, any user that can log to your server will have admin access to all your Mongo databases !
|
||||
* Single-sign on or LDAP are not integrated
|
||||
* It's strongly recommanded you don't enable public access to the application
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
* It doesn't backup Mongo databases
|
||||
* As mongo-express doesn't require any database by itself, it doesn't backup or restore any of them
|
||||
* However, yYou can view / edit other applications databases with Mongo-Express
|
||||
* It will just reinstall the Mongo server if you installed it with this script
|
||||
* Any yunohost applications using Mongo databases should manage the backup and restore
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://example.com>
|
||||
* Official user documentation: <https://yunohost.org/apps>
|
||||
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
||||
* Upstream app code repository: <https://some.forge.com/example/example>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Official app website: <https://github.com/mongo-express/mongo-express>
|
||||
* Upstream app code repository: <https://github.com/mongo-express/mongo-express>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_mongo-express>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/mongo-express_ynh/issues>
|
||||
|
||||
## 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.
|
||||
|
||||
``` 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
|
||||
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>
|
||||
|
|
|
|||
74
README_fr.md
74
README_fr.md
|
|
@ -3,71 +3,77 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
|
|||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Exemple d'app pour YunoHost
|
||||
# Mongo Express pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/mongo-express)  
|
||||
[](https://install-app.yunohost.org/?app=mongo-express)
|
||||
|
||||
*[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.*
|
||||
|
||||
## 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
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
- Optionally installs Mongo server
|
||||
- Connect to multiple databases
|
||||
- View/add/delete databases
|
||||
- View/add/rename/delete collections
|
||||
- View/add/update/delete documents
|
||||
- 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
|
||||
|
||||
**Démo :** https://demo.example.com
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
* For now, any user that can log to your server will have admin access to all your Mongo databases !
|
||||
* Single-sign on or LDAP are not integrated
|
||||
* It's strongly recommanded you don't enable public access to the application
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
* It doesn't backup Mongo databases
|
||||
* As mongo-express doesn't require any database by itself, it doesn't backup or restore any of them
|
||||
* However, yYou can view / edit other applications databases with Mongo-Express
|
||||
* It will just reinstall the Mongo server if you installed it with this script
|
||||
* Any yunohost applications using Mongo databases should manage the backup and restore
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : <https://example.com>
|
||||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
||||
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
|
||||
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Site officiel de l'app : <https://github.com/mongo-express/mongo-express>
|
||||
* Dépôt de code officiel de l'app : <https://github.com/mongo-express/mongo-express>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_mongo-express>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/mongo-express_ynh/issues>
|
||||
|
||||
## 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.
|
||||
|
||||
``` 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
|
||||
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>
|
||||
|
|
|
|||
Loading…
Reference in a new issue