From b9077663f53d2a5f3ce3ce52c9249d4b0c684fd9 Mon Sep 17 00:00:00 2001 From: Nick Cox Date: Wed, 6 Apr 2016 11:35:10 -0600 Subject: [PATCH] Docs for mongo-express official image --- mongo-express/content.md | 64 +++++++++++++++++++++++++++++++++++++++ mongo-express/logo.png | Bin 0 -> 17847 bytes 2 files changed, 64 insertions(+) create mode 100644 mongo-express/content.md create mode 100644 mongo-express/logo.png diff --git a/mongo-express/content.md b/mongo-express/content.md new file mode 100644 index 000000000..cec690dab --- /dev/null +++ b/mongo-express/content.md @@ -0,0 +1,64 @@ +# What is mongo-express? + +mongo-express is a web-based MongoDB admin interface written in Node.js, Express.js, and Bootstrap3. + +> [github.com/mongo-express/mongo-express](https://github.com/mongo-express/mongo-express) + +%%LOGO%% + +# How to use this image + +```console +$ docker run --link some_mongo_container:mongo -p 8081:8081 mongo-express +``` + +Then you can hit `http://localhost:8081` or `http://host-ip:8081` in your browser. + +## Security Notice + +JSON documents are parsed through a javascript virtual machine, so the web interface can be used for executing malicious javascript on a server. + +**mongo-express should only be used privately for development purposes.** + +# Configuration + +Environment vairables are passed to the `run` command for configuring a mongo-express container. + + Name | Default | Description + --------------------------------|-----------------|------------ + ME_CONFIG_BASICAUTH_USERNAME | '' | mongo-express web username + ME_CONFIG_BASICAUTH_PASSWORD | '' | mongo-express web password + ME_CONFIG_MONGODB_ENABLE_ADMIN | 'true' | Enable admin access to all databases. Send strings: `"true"` or `"false"` + ME_CONFIG_MONGODB_ADMINUSERNAME | '' | MongoDB admin username + ME_CONFIG_MONGODB_ADMINPASSWORD | '' | MongoDB admin password + ME_CONFIG_MONGODB_PORT | 27017 | MongoDB port + ME_CONFIG_MONGODB_SERVER | 'mongo' | MongoDB container name + ME_CONFIG_OPTIONS_EDITORTHEME | 'default' | mongo-express editor color theme, [more here](http://codemirror.net/demo/theme.html) + ME_CONFIG_REQUEST_SIZE | '100kb' | Maximum payload size. CRUD operations above this size will fail in [body-parser](https://www.npmjs.com/package/body-parser). + ME_CONFIG_SITE_BASEURL | '/' | Set the baseUrl to ease mounting at a subdirectory. Remember to include a leading and trailing slash. + ME_CONFIG_SITE_COOKIESECRET | 'cookiesecret' | String used by [cookie-parser middleware](https://www.npmjs.com/package/cookie-parser) to sign cookies. + ME_CONFIG_SITE_SESSIONSECRET | 'sessionsecret' | String used to sign the session ID cookie by [express-session middleware](https://www.npmjs.com/package/express-session). + ME_CONFIG_SITE_SSL_ENABLED | 'false' | Enable SSL. + ME_CONFIG_SITE_SSL_CRT_PATH | '' | SSL certificate file. + ME_CONFIG_SITE_SSL_KEY_PATH | '' | SSL key file. + +The following are only needed if `ME_CONFIG_MONGODB_ENABLE_ADMIN` is **"false"** + + Name | Default | Description + --------------------------------|-----------------|------------ + ME_CONFIG_MONGODB_AUTH_DATABASE | 'db' | Database name + ME_CONFIG_MONGODB_AUTH_USERNAME | 'admin' | Database username + ME_CONFIG_MONGODB_AUTH_PASSWORD | 'pass' | Database password + +## Example + + docker run -it --rm \ + --name mongo-express \ + --link web_db_1:mongo \ + -p 8081:8081 \ + -e ME_CONFIG_OPTIONS_EDITORTHEME="ambiance" \ + -e ME_CONFIG_BASICAUTH_USERNAME="user" \ + -e ME_CONFIG_BASICAUTH_PASSWORD="fairly long password" \ + knickers/mongo-express + +This example links to a container name typical of `docker-compose`, changes the editor's color theme, and enables basic authentication. diff --git a/mongo-express/logo.png b/mongo-express/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..339762f06264a0b17e510a967bf09874a3482361 GIT binary patch literal 17847 zcmeI4c|4Ts`^TR#s2o&^qe9bY#h4jp%osDYAPL#B6f$NWjAdq;g|XGpLc3EG=}?Il zB}`G*6QXRDqwh0FdaC)I@9X>h{eJ(xlnHapxTJIbVfKRKm~yzEH(}Oy6Pet#bVOX-b81dGj|CX z%5sS1fgZ6go{ZRVh9whiW35INQ6PaxP(VkCA|u#*iin0D(xpJZWzASLYN(4KoQ7T` z8xZB=?21~#;ejZkDG|fK;Rz^`r750>Cy?|I5GYZa4nqoEgT9;0fiS8T5xY#*rvE+!&GJo-hq(4wDre^9>DiGYZ~ftj3t0a1ChdFzEvN zKT;XncZ?2`K?&yYBIyEaRwO+H#B$joRP5)*F+E2Uin4?g!Qnxd1zMX^vEOPQ6E&1% zlx1wbfX-%s%WSQo22&P`NioL-1u-qiBn%yA$;5zo0s%uO1Q9SKOFEta;z>Ay1#<|Z zv-8;SucU1`454hJj7T#fX%c}+BGDO441vxdVuDBn5EB$kqGJezUB#Rl^v=ll+R>-Uwvb_L8fWK({d|9KBBVnws7x14^9@ZZd{{1nc zLqWE@4K*w^)a&~qd`_?+n$80kg+Mv+KWy`1!7n4=%2ceZ=0~vpH`ai|jskiA&MH7_ zO^5E6Adhby%;Q9&=v;0Di$RyIC^m}C9J%3)?nsn?gBr7|ho?J6mTmv6 zT>NL*_C@Laf62Db`;-w%XNQ1HYwV{j`l;ccE!uF}epx#{mAtQO4OMopr9gEG+A~Ah zWR0g{ziRtD@^F72S-pu64%HKq84h}3@v_g6(6MfKsIUCcv2J+i=g5_8mcZIEqqzU#G64A8w!GZz8UHJ-N-SX zk;vi28gtGZDmKHd&?y!=Kx0Qw&|lS|(MtW_{PB58|4mhxmSPYX5c#G8mwY}juL2hg zhtH1>VBHvWtlFtX`Rp5dFk#8z+$>#&}DsaJo$TtZz^!f=L7R9aKV7cHx;<#^MQF4xL`o! zn+ja=`M|siTreQ=O$9Fbd|+M$E*KE`rUI9IJ}|EW7YvAeQ-Mo9ADCBx3kF2KslX+l z56r8;1p^}Al#5I4^E0U+8+s5m8hYZiw&DG0=xJ3H!@=Dd0Al9=fOrD{y!!}!zXSjw z4ggvMp$A^oq!_2f z&LZ;{X}|__`b~$B(BjQHlg^$JrY<_dEo~3~{(D^xEu{VfxrI$CJ83*mQsivN z>|27UM4T5-MNM;1dVIOT<-iof_(DV>@~lMrpr2me!U?YGQ-P3LOCEBs>lTS?APzUF z4nQY#f0)%3cOd!g2{9)TDX~UPJU83ppdPz?_2#K1f|)feqm7LmD1KDsaFwH(n4JJdwI{& zt!JNJ3>X)bc>Kk!A5Xo=;CVmb3KMD*jx2Tb5+qek?LT$H&iils>Q=o(RcgIU#paiN z=nDuWby^0SkMnHI@~C8MN`I1QSqO;i5p#K+-N_M8ng0PPk+PXrxT?Pfj>kU zZoU_Wd2GNUNbQ<$>`HW3Eoyd<)GO_2BaidEm$acn{KT!QJVGVFSY@I=0(+&SUPI^X zTZ@8TozC$lIIUcNTRpc!ZeEF018k-4d4yi;t8FwNV&Mm$>^SE3boVzOl2()g7uBgj zn?kocO}p8goKvhNO;(wC5n;2DQsy0IsXdRMe0{DFVQWT_u60 zRn^KU%SJJFRWJfdQvO#68Az@#>4Q#9TT1U%G~=-Gl|M%gfJ0X@g}#qu)DkD=BsUU zZA^R8o>?EeMjKS_bX6*)29`2C>s{^RDf+oqb!yEB_2UyoMccEf4fn{UIlaX-v+D@w ztfh-eVmf{NqP5i9dT0D(rkDK7EMw^+A;S3B59=NCu4^LI&#!axA)J4br>~T)Ie)s; zb75se=-*l&rmx#I>u1&9)W~WMO+a7TjrZIT(VmBiv7v##4w_v|ZX`+`GE1qaoKGxh zzoLKme&d|{(vxD3SHTVLzg;(Sszmfe>`6O}*xNC=eG+I8Xda-VdVHHI+0Eiw)twm* zAp#4`aV?@G5-g?8CEPy~cXnIK9&PSwjUs`;8D5!Ldq6S0xI}4ZBe1-Dy?gw|m?`=X z9jdGjcp&w*V2q6%k$Og1PqmJo5Fe3NmG}k(Bs86g+eAL%?{v%_={G0qDXHTTt}B29 zs>FLB{S337?kgzF$XK1WJSQpd?ZI=0FIOiYf4}vl_!?2-4VDg^EU2qa{%s}NSXwY$ zy1c}9UCF>j&nC|--s#4|#lDC&w}CaOH{Qf`#OWD-xYPN;^RDOHhfR$oN*4|yOm{cD zU!U{wc4wU4`>ybgmMTMIDO#h`ciO4?57vKlO4rByX*~N*f@B`^%%Il|j5YRNxSxJ* z+2(5-*g)th}Adk(|tjh{j;Korh#=sU=91XqFs&*QUa-5u<| zOv&_kz4l;PhompwmlpFeE3a}5pY!tK{DMjobLromjhPxBm_3(;4{A>&5i9-ccVs>N z)oWHoZ_~H|?Yal!$_Ib9cQkSoR@}MDn7Ow74l(o3%EapTVk}}Qvo|biuqAj+?yZ%V zue`SYiPmEhygKL?VagG-{Us_o%_2RyGeAi37+K6m1zF8xpENS1{ ziJ0!n%&rZby~R(jN0}U6(WswI+xIKi6O_*Z zO|01j~VWjdPMmA`+1Wx8uY&3R1|&WoAZz`kuqFPT-Y^-c)Tj@f7bCN1`K zznZR;CIQpu`<)v^0<*R@I&zJb=M5m@HTttwqTOPSYKc2jxyFd>dE|F0x^B%Sw#P3E ztCCtC(+-%}fZFHmoX^|qv&*ySS^NF$M6-*gtggv-lbEiUC#pK%R=By(T@9%BXnciKZl^J)kOFdRxirCZb{O z{^m)mCQ4RHeB5fvz-%LNNY~m5joSJwZKaE<9rxCf?D}l06S9w;Bs|Htaw{jC1*`Ml zJh=lXk4fQ@0e_HLla`n!grBv+= z+x<6J)*iq1>{+^>q;cWSM?ZS06Jkl7=54_@@;$|s_&!rZ(?Z>d_*u9~+cb{cbt|xo zSD%5;&5+t^hmoFOi$Clk`cLi>P2RAN=j9{_Gj7$1#UwE6R3|5&3T|=2->WbSq_+AT zzNDjC=Gsp)m~vEQ0fHB`PqcMSIATuZzRuF4ZYswEmDRc9gpw$u*5+3;bdYh#4C8^g z75&SXE1i5fy>o7=`t`+wzB|B6yO@D<4OH{Wr%Lu;O|)F7)q1dG!|p`d{5BV@b;`A2 zrjCqV=rSTc%^nSLI zVC#J8?A(qMC-l{Btr|FKr=RCz{3!jt8+vCDqSu5Xe4yg^aR%VB!sl7HC4IZ>U#l#$ LbFnR49GLVk6bOEP literal 0 HcmV?d00001