From 543ed10ed132af12c3662c7a04010d3f36538094 Mon Sep 17 00:00:00 2001 From: David Audet Date: Tue, 26 Jul 2016 13:42:49 -0700 Subject: [PATCH 1/3] Adding docs for Eclipse Mosquitto --- eclipse-mosquitto/README-short.md | 1 + eclipse-mosquitto/content.md | 49 ++++++++++++++++++++++++++++++ eclipse-mosquitto/github-repo.md | 1 + eclipse-mosquitto/license.md | 1 + eclipse-mosquitto/logo.png | Bin 0 -> 2798 bytes 5 files changed, 52 insertions(+) create mode 100644 eclipse-mosquitto/README-short.md create mode 100644 eclipse-mosquitto/content.md create mode 100644 eclipse-mosquitto/github-repo.md create mode 100644 eclipse-mosquitto/license.md create mode 100644 eclipse-mosquitto/logo.png diff --git a/eclipse-mosquitto/README-short.md b/eclipse-mosquitto/README-short.md new file mode 100644 index 000000000..68d3365b6 --- /dev/null +++ b/eclipse-mosquitto/README-short.md @@ -0,0 +1 @@ +Eclipse Mosquitto is an open source message broker which implements MQTT protocol version 3.1 and 3.1.1. diff --git a/eclipse-mosquitto/content.md b/eclipse-mosquitto/content.md new file mode 100644 index 000000000..cac0c8437 --- /dev/null +++ b/eclipse-mosquitto/content.md @@ -0,0 +1,49 @@ +# What is Eclipse Mosquitto? + +Eclipse Mosquitto is an open source implementation of a server for version 3.1 and 3.1.1 of the MQTT protocol. Main homepage: http://mosquitto.org/ + +%%LOGO%% + +# How to use this image + +##Mount Points + +Three mount points have been created in the image to be used for configuration, persistent storage and logs. +``` +/mosquitto/config +/mosquitto/data +/mosquitto/log +``` + + +##Configuration + +When running the image, the default configuration values are used. +To use a custom configuration file, mount a **local** configuration file to `/mosquitto/conf/mosquitto.conf` +``` +docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf eclipse-mosquitto +``` + +Configuration can be changed to: + +* persist data to `/mosquitto/data` +* log to `/mosquitto/log/mosquitto.log` + +i.e. add the following to `mosquitto.conf`: +``` +persistence true +persistence_location /mosquitto/data/ + +log_dest file /mosquitto/log/mosquitto.log +``` + +**Note**: If a volume is used, the data will persist between containers. + +##Run +Run a container using the new image: +``` +docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto +``` +:boom: if the mosquitto configuration (mosquitto.conf) was modified +to use non-default ports, the docker run command will need to be updated +to expose the ports that have been configured. diff --git a/eclipse-mosquitto/github-repo.md b/eclipse-mosquitto/github-repo.md new file mode 100644 index 000000000..f5c8c7a81 --- /dev/null +++ b/eclipse-mosquitto/github-repo.md @@ -0,0 +1 @@ +https://github.com/eclipse/mosquitto diff --git a/eclipse-mosquitto/license.md b/eclipse-mosquitto/license.md new file mode 100644 index 000000000..87d41d6b9 --- /dev/null +++ b/eclipse-mosquitto/license.md @@ -0,0 +1 @@ +Eclipse Mosquitto is released under the [EPL](https://www.eclipse.org/legal/epl-v10.html)/[EDL](https://eclipse.org/org/documents/edl-v10.php) diff --git a/eclipse-mosquitto/logo.png b/eclipse-mosquitto/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..fa85de4565429fb6744b1ea71abb3bec023d6a6f GIT binary patch literal 2798 zcmVk?%{q64A-7D-xGTDVgJ$jZqu9?xes_M19+5JCc{OR*Y zdyaQk%HiyW8vD_nY|NgN>7Oqetn{oC81Fe=W2SumguaEkcgd8`pWr!OBQPQ7@;e_C!SJ-+e!DOi&-B;;qY++q3%$?A|1utu9yb)&e2;V{;A<0OoaP^Jir5X0{wuI!$(c*-1KHcThhK4v+)%- z{LoYPRUqGQm1%-@sq$x_An0*t^JuQbTCa~dNIGlh0rP@-w<6~oA*ZSi#D2)pX}i9TC^CEqgsq$~+ygu#Cm79EcniMGk5 z+3Ja5TSP=%ofCKFrYCEz`y3!sVb2w)2wFZju9@6iYu^PZIpc;OlvUax-xPUSr5%#4 zu-^x0uC?!?=2Vo9p!v*n)=mRxSZTK@{4VS#=-ggJ#-BcaG(uUR+v27M-U~44yqgPE zxh3w%)nQI4$u1aSjQe!Xr8Qk{M}A!r>2f&0B)f6qpVf&`-_>XsfxZOW?N9hhsQD zBq9jmVphpH%K@;~AUZSbV8mPrD8PU`76L~lFdZcDRJz?TubM*+hC5MFFtHRpYR(wAj25Kftv#@ecv05X;K zXoZkqH_9D>(*X$enXJ9&t4L(B_9BFOV1N&pJAhpQhAYOG-!KZGd1cjl;O~L{$V^4` zB!K1`yGh~Yz};cvD(q24a}uq5Raq65MRal^_T7<<%T>gi#Ny_9dj-mLpa)1P+?&bT z*}lcfdb10;2=u;t2qa_4aAtiC~mZFP(Z*ksm-BLjOiI6UB`&I8Hvp0s3uo z-@~8ID2y-&MS;-=4GlKue;FAZIgw}@pimqUG5%uf*6!njuK^y*0o0Ph@DROsq=PUl zQ|sFbJRIm#q`o*FKtx}O2QAoueB1W0oDvQI2(W$-v=20BL}Vwimxzd{e4cRly|C=K ze&$tA!#sm=*a)zrt2o{XdrNW92AH>Fzd95^g>A&jD3(HmK{X!a1m+?GgsrY8A0~{W>12dY!m=Y;><95T2mnuI9KfK(o8Bc@14&U>Gw7E0{so|( zZ|leNzod#cJTgv9X+-0%>ypG4V(v6b1n%Imm)w&FU{c=Z*dK>QKs?@zoqHz&G}YSI z2v4ME9M-aJ`uFu?M_Vt|A-@KczN60T5taW;CY-7#gas<#9-#~QkwyORB8JG z2L~hci2=e9P4)Y1%Lst3!9%xz|7jJDBghfPi}QoRX;D$+k3soR$L+WskU@(#eP%=! zh4x0}#=*D$dmAA6dE5aE4G`Z&lqWQC#ED`F%5gz?M=>Km0vMd*aKam|@Q#rLbK}Zb zfb~l*?ExAC_0UY#9tY64s_J#%-9Vo%t+2-fbnVjHP{P~VC8g!|PbW@Ycu0@S*3fs4 zk*#Hwc1SvFmkET&m^a;2(VYO9GwcaKiI0noEwxo|0F+kPu|RlLXsD?<%U`p`#~S)E zs?r(}AWz%iG z&ne#Pfm1Ts>KOn{HTDhHp;Y4JRk*%;Xc7Ldn0vYFkbyu*>^X#zwpzOZAYE=RM>sij z>L{-Q1nce6mb?cBG4)q(L)w?i&2Inz$^ zVjTh-UC)HhX{)gtn~voqQO*JW+HIUd;4@%rw{Z$ZS*OU^&Brn>yk!D->O3Y89XUK$ zU2>+KYY7YfyT4|qyXkH!=l0aBfP*^yzwchq7 zu_sY!Cvn8so3z&3j|&P5CnAJvGcSk<@K{T&eF2~>Yl|Ve2zK^#u`D9;WX*M-D?AW1 z_9sPk7{GP7oW$`(VQH$Jsp}rRX0O@1ml&@diFdCrlXVYXvm@2cRE4Dp^$sMu$dOa3 zf&Ksj_dUDDc0@${Lf#^REH7|DxV5&`*o{c=@~A9qsk0Y`hs%8tQMQVH^%n`Hp~2=_ z>gyqB;M7y^><`dfYws6Ky1CxY zA=t_GRXnBLL-v_SAlh7S=LjaU^gOb*39fy;R2vLP)!+E zxnNJn@qHG7b}{??MS4kqp**O5A;NhLOYIj)oB#P)p{3TofN}}2S%isgHFGxaZnIzF zua9p;q^)MoW}{9Tcu$cTO?CFgeeN9IjlZdM&Kfqc^Sa`)Z^PHOh3RX__G^cY*?x8L zv3(sU)z<-x(oX;V+v&cJ^f{4&9%=XAI{H@r3-c`R{$N%azyJUM07*qoM6N<$f*hz# Aa{vGU literal 0 HcmV?d00001 From bbaa26f8e22a27bc14dc9527777b73b12cd5c2e5 Mon Sep 17 00:00:00 2001 From: David Audet Date: Fri, 23 Sep 2016 10:42:37 -0700 Subject: [PATCH 2/3] Fix markdown format issues and github-repo file extension --- eclipse-mosquitto/content.md | 39 ++++++++----------- .../{github-repo.md => github-repo} | 0 2 files changed, 16 insertions(+), 23 deletions(-) rename eclipse-mosquitto/{github-repo.md => github-repo} (100%) diff --git a/eclipse-mosquitto/content.md b/eclipse-mosquitto/content.md index cac0c8437..c9ceb0e9b 100644 --- a/eclipse-mosquitto/content.md +++ b/eclipse-mosquitto/content.md @@ -9,41 +9,34 @@ Eclipse Mosquitto is an open source implementation of a server for version 3.1 a ##Mount Points Three mount points have been created in the image to be used for configuration, persistent storage and logs. -``` -/mosquitto/config -/mosquitto/data -/mosquitto/log -``` + /mosquitto/config + /mosquitto/data + /mosquitto/log ##Configuration -When running the image, the default configuration values are used. -To use a custom configuration file, mount a **local** configuration file to `/mosquitto/conf/mosquitto.conf` -``` -docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf eclipse-mosquitto -``` +When running the image, the default configuration values are used. To use a custom configuration file, mount a **local** configuration file to `/mosquitto/conf/mosquitto.conf` + + docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf eclipse-mosquitto Configuration can be changed to: -* persist data to `/mosquitto/data` -* log to `/mosquitto/log/mosquitto.log` +- persist data to `/mosquitto/data` +- log to `/mosquitto/log/mosquitto.log` i.e. add the following to `mosquitto.conf`: -``` -persistence true -persistence_location /mosquitto/data/ -log_dest file /mosquitto/log/mosquitto.log -``` + persistence true + persistence_location /mosquitto/data/ + log_dest file /mosquitto/log/mosquitto.log **Note**: If a volume is used, the data will persist between containers. ##Run + Run a container using the new image: -``` -docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto -``` -:boom: if the mosquitto configuration (mosquitto.conf) was modified -to use non-default ports, the docker run command will need to be updated -to expose the ports that have been configured. + + docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto + +:boom: if the mosquitto configuration (mosquitto.conf) was modified to use non-default ports, the docker run command will need to be updated to expose the ports that have been configured. diff --git a/eclipse-mosquitto/github-repo.md b/eclipse-mosquitto/github-repo similarity index 100% rename from eclipse-mosquitto/github-repo.md rename to eclipse-mosquitto/github-repo From 36c7f99f2be8c1ae18420e5f3cd499700312480e Mon Sep 17 00:00:00 2001 From: David Audet Date: Wed, 30 Nov 2016 11:18:08 -0800 Subject: [PATCH 3/3] Address review comments --- eclipse-mosquitto/content.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/eclipse-mosquitto/content.md b/eclipse-mosquitto/content.md index c9ceb0e9b..c7a81b86a 100644 --- a/eclipse-mosquitto/content.md +++ b/eclipse-mosquitto/content.md @@ -6,15 +6,15 @@ Eclipse Mosquitto is an open source implementation of a server for version 3.1 a # How to use this image -##Mount Points +## Directories -Three mount points have been created in the image to be used for configuration, persistent storage and logs. +Three directories have been created in the image to be used for configuration, persistent storage and logs. /mosquitto/config /mosquitto/data /mosquitto/log -##Configuration +## Configuration When running the image, the default configuration values are used. To use a custom configuration file, mount a **local** configuration file to `/mosquitto/conf/mosquitto.conf` @@ -33,10 +33,10 @@ i.e. add the following to `mosquitto.conf`: **Note**: If a volume is used, the data will persist between containers. -##Run +## Run Run a container using the new image: docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto -:boom: if the mosquitto configuration (mosquitto.conf) was modified to use non-default ports, the docker run command will need to be updated to expose the ports that have been configured. +**Note**: if the mosquitto configuration (mosquitto.conf) was modified to use non-default ports, the docker run command will need to be updated to expose the ports that have been configured.