mirror of
https://github.com/YunoHost-Apps/mongo-express_ynh.git
synced 2024-09-03 19:46:04 +02:00
Documentation
This commit is contained in:
parent
c570a3abb4
commit
6e620ccf1c
12 changed files with 136 additions and 21 deletions
0
.idea/.gitignore
generated
vendored
Normal file
0
.idea/.gitignore
generated
vendored
Normal file
6
.idea/misc.xml
generated
Normal file
6
.idea/misc.xml
generated
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectRootManager">
|
||||||
|
<output url="file://$PROJECT_DIR$/out" />
|
||||||
|
</component>
|
||||||
|
</project>
|
8
.idea/modules.xml
generated
Normal file
8
.idea/modules.xml
generated
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/mongo-express_ynh.iml" filepath="$PROJECT_DIR$/.idea/mongo-express_ynh.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
9
.idea/mongo-express_ynh.iml
generated
Normal file
9
.idea/mongo-express_ynh.iml
generated
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="JAVA_MODULE" version="4">
|
||||||
|
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||||
|
<exclude-output />
|
||||||
|
<content url="file://$MODULE_DIR$" />
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
6
.idea/vcs.xml
generated
Normal file
6
.idea/vcs.xml
generated
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
61
.idea/workspace.xml
generated
Normal file
61
.idea/workspace.xml
generated
Normal file
|
@ -0,0 +1,61 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="AutoImportSettings">
|
||||||
|
<option name="autoReloadType" value="SELECTIVE" />
|
||||||
|
</component>
|
||||||
|
<component name="ChangeListManager">
|
||||||
|
<list default="true" id="64d4b817-665f-4b81-a2cb-414917b75bbc" name="Changes" comment="First working release" />
|
||||||
|
<option name="SHOW_DIALOG" value="false" />
|
||||||
|
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||||
|
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
||||||
|
<option name="LAST_RESOLUTION" value="IGNORE" />
|
||||||
|
</component>
|
||||||
|
<component name="MarkdownSettingsMigration">
|
||||||
|
<option name="stateVersion" value="1" />
|
||||||
|
</component>
|
||||||
|
<component name="ProjectId" id="2IzWOucBwNDNNlV73dYNIcWk469" />
|
||||||
|
<component name="ProjectViewState">
|
||||||
|
<option name="hideEmptyMiddlePackages" value="true" />
|
||||||
|
<option name="showLibraryContents" value="true" />
|
||||||
|
</component>
|
||||||
|
<component name="PropertiesComponent"><![CDATA[{
|
||||||
|
"keyToString": {
|
||||||
|
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
||||||
|
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||||
|
"WebServerToolWindowFactoryState": "false",
|
||||||
|
"last_opened_file_path": "/home/gc-garunda/devs/yunohost/ynh-dev",
|
||||||
|
"node.js.detected.package.eslint": "true",
|
||||||
|
"node.js.detected.package.tslint": "true",
|
||||||
|
"node.js.selected.package.eslint": "(autodetect)",
|
||||||
|
"node.js.selected.package.tslint": "(autodetect)",
|
||||||
|
"vue.rearranger.settings.migration": "true"
|
||||||
|
}
|
||||||
|
}]]></component>
|
||||||
|
<component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
|
||||||
|
<component name="TaskManager">
|
||||||
|
<task active="true" id="Default" summary="Default task">
|
||||||
|
<changelist id="64d4b817-665f-4b81-a2cb-414917b75bbc" name="Changes" comment="" />
|
||||||
|
<created>1671184863453</created>
|
||||||
|
<option name="number" value="Default" />
|
||||||
|
<option name="presentableId" value="Default" />
|
||||||
|
<updated>1671184863453</updated>
|
||||||
|
<workItem from="1671184864536" duration="784000" />
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00001" summary="First working release">
|
||||||
|
<created>1671184974283</created>
|
||||||
|
<option name="number" value="00001" />
|
||||||
|
<option name="presentableId" value="LOCAL-00001" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671184974283</updated>
|
||||||
|
</task>
|
||||||
|
<option name="localTasksCounter" value="2" />
|
||||||
|
<servers />
|
||||||
|
</component>
|
||||||
|
<component name="TypeScriptGeneratedFilesManager">
|
||||||
|
<option name="version" value="3" />
|
||||||
|
</component>
|
||||||
|
<component name="VcsManagerConfiguration">
|
||||||
|
<MESSAGE value="First working release" />
|
||||||
|
<option name="LAST_COMMIT_MESSAGE" value="First working release" />
|
||||||
|
</component>
|
||||||
|
</project>
|
23
LICENSE
23
LICENSE
|
@ -1,4 +1,21 @@
|
||||||
File containing the license of your package.
|
The MIT License (MIT)
|
||||||
|
|
||||||
More information here:
|
Copyright (c) 2014-2019 The Wekan Team
|
||||||
https://yunohost.org/packaging_apps_guidelines#yep-1-3
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
|
@ -1,9 +1,20 @@
|
||||||
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
|
||||||
|
|
|
@ -1,12 +1,9 @@
|
||||||
* 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
|
||||||
|
|
BIN
doc/screenshots/collection-view.png
Normal file
BIN
doc/screenshots/collection-view.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 747 KiB |
BIN
doc/screenshots/databases-view.png
Normal file
BIN
doc/screenshots/databases-view.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 460 KiB |
BIN
doc/screenshots/document-edit.png
Normal file
BIN
doc/screenshots/document-edit.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 244 KiB |
Loading…
Add table
Reference in a new issue