From d36235b330f3945d48c230eb58f3ea8319b6d985 Mon Sep 17 00:00:00 2001 From: Geo Date: Wed, 6 Jul 2016 01:04:57 -0400 Subject: [PATCH 1/3] Create docs repo --- eggdrop/README-short.txt | 1 + eggdrop/content.md | 37 +++++++++++++++++++++++++++++++++++++ eggdrop/github-repo | 1 + eggdrop/license.md | 1 + eggdrop/logo.png | Bin 0 -> 4435 bytes 5 files changed, 40 insertions(+) create mode 100644 eggdrop/README-short.txt create mode 100644 eggdrop/content.md create mode 100644 eggdrop/github-repo create mode 100644 eggdrop/license.md create mode 100644 eggdrop/logo.png diff --git a/eggdrop/README-short.txt b/eggdrop/README-short.txt new file mode 100644 index 000000000000..9ab12aab4bb0 --- /dev/null +++ b/eggdrop/README-short.txt @@ -0,0 +1 @@ +The official Docker image of Eggdrop- IRC's oldest actively-developed bot! diff --git a/eggdrop/content.md b/eggdrop/content.md new file mode 100644 index 000000000000..aa7e30a2be61 --- /dev/null +++ b/eggdrop/content.md @@ -0,0 +1,37 @@ +# What is Eggdrop? + +Eggdrop is the world's most popular Open Source IRC bot, designed for flexibility and ease of use, and is freely distributable under the GNU General Public License (GPL). It is designed to Linux, *BSD, SunOs, Windows, and Mac OS X, among others. The core codebase is extendable via TCL scripts or C modules and bots can be linked to form botnets, enabling the sharing of userfiles and partylines across multiple bots. + +%%LOGO%% + +# How to use this image + +## First Run + +To run this container the first time, you'll need to pass in, at minimum, a nickname and server via Environmental Variables. At minimum, a docker run command similar to + + docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net eggheads/eggdrop:latest + +should be used. This will modify the appropriate values within the config file, then start your bot with the nickname FooBot and connect it to irc.freenode.net. + +These variables are only needed for your first run- after the first use, you can edit the config file directly. + +## Long-term Persistence + +After running the eggdrop container for the first time, the configuration file, user file and channel file will all be available inside the container at /home/eggdrop/eggdrop/data/ . NOTE! These files are only as persistent as the container they exist in. If you expect to use a different container over the course of using the Eggdrop docker image (intentionally or not) you will want to create a persistent data store. The easiest way to do this is to mount a directory on your host machine to /home/eggdrop/eggdrop/data. If you do this prior to your first run, you can easily edit the eggdrop configuration file on the host. Otherwise, you can also drop in existing config, user, or channel files into the mounted directory for use in the eggdrop container. To do this, start your container with something similar to + + docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data eggdrop + +## Exposing network ports + +If you want to expose network connections for your bot, you'll also want to use the -p flag to expose whichever port you specified in the config as the listen port (default is 3333). For example, to expose port 3333, add + + -p 3333:3333 + +to your docker run command line. + +## Troubleshooting / Support + +For additional help, you can join the #eggdrop channel on Freenode + +The git repository for the Dockerfile is maintained at https://github.com/eggheads/eggdrop-docker diff --git a/eggdrop/github-repo b/eggdrop/github-repo new file mode 100644 index 000000000000..1915e5dc0243 --- /dev/null +++ b/eggdrop/github-repo @@ -0,0 +1 @@ +https://github.com/eggheads/eggdrop-docker diff --git a/eggdrop/license.md b/eggdrop/license.md new file mode 100644 index 000000000000..63bea3fd15c0 --- /dev/null +++ b/eggdrop/license.md @@ -0,0 +1 @@ +View [license information](https://www.gnu.org/licenses/gpl-3.0.en.html) for the software contained in this image. diff --git a/eggdrop/logo.png b/eggdrop/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..4438fd47a1728d0223db8028b01e63e8ebbe880f GIT binary patch literal 4435 zcmc&!XIN8Nx85g>5D5e%7>arbgf1jB0YO3tNFNL^BBDYd6e)=z3JB;)2!e{rP!tt0 zv@41Q3!sQ&f+*N1ij1Ixu>dNLVwsUqkPp0{^W7iU`}gkWJm;*v_q*P;)>-efR`_~5 zIY)CqHW&>93XsTeaINev< z%*`pcdV0*AS(lrx*A=F*vPvhOKbB@mV>m4HtnRwHlXyJk?a9IjPQ+k$$J@)Lt~P82 zixnR3&yZd}Qo8Ho_=qs4pyyVPFej(2^J+z1MNCrR$k<5jk=lXo;UsAm?B)OrDIY)l zH8nMTvM?(x#t$xOVM*(pBeKr5bT*$lHa`B^#>SPmF}+Tj1Rv}-H>7~VZUDf{w>4}0 zKQ6PCHg=?WE2jCG@~atNdc3OsoUi9TC| zypSzHp)p&MVw_{C?#p4<43~@)K?+Y44QHezr>41NxKX2H`COjMtUY&ZLxsOVL`iN` zkGTtYE~Y16$b%iM?UuyQ84TFb(VAiJ;ONM(f^F#xTO0c9N7!stVrncuJ2AqK=)+Z+0ohd&R$MV-rs%M{FqHCyj0P5-`M~7+W*jZP6{c4*~o03 zFmW?4)?3I=fxngPlKA6X7(e9uw{Pr^bFuxQugz>SHgk>rAC3NgG^?ID^B>vHZvGKI zFLhS!!dY2EGhe5tzI^_B^3z{`e*EzM-Nf5Bf4m-l_438o=*aVDPoF3s5C8t?;n3iN z-v;jY-@Dt_+tYpL_N|*Yx;n34>$uvkkYD-ra@(cWix*m&o6es*d#3U9sgoxfjvuQ( z`d@XmHPuzJBbA3M4jnvDzJFg?X-V-fMSJ(`F5IuSDLpyzd)+)fK%VGx9FGRl6+GP zMt3_*gi9-r$Ry z78~{xrR$Yp%x~um80VorN97FJb}? z1s-mFpK^-a?^2^B7Wmd*xkPQ;aWMjmw_oxsa8Jl=8$!-@o{NK@X_PfjUvvXX6r!r4 zW;qZHe2x(C@hZu*2t=$FTovO(#cWmb;<_&6m+1tUiPA7o zjvg{oD+0j=spmoF*O8aQG)y+l#Mq5FP_s@$;H&`jSA**zL$hGX?y1)#NpTJ(urGbUT3kSl$n*OLx(`>^&Jw_e6v<#n(l*-+SriW&d~8UXIgWCd+iGa zRJJdaRp}ah>@j-ZfYP_bC+N&osI67Sq1|) zs#udBZf&5T2FvF8svVgYh_?Z{)Ff!$WPFJ9fzJJPIhBQWh)U2(!zU?i@0Al-)gCgx z8DmqnOnqrCQ3<;bPU}ou9b5_Pp^r~Fcg@4R-mxQuLTrc@c5?XAdv*rG08Z)edb%3qr>& zmEF*S*ISHxoYt=zYBFTJ_GOc)QO_l) zFL5f>-bV4JM*d!QOhxm!)?bgkFK99E8~%FXw;S_N0dP(KA32e{ZCkH6VKqXcC?Zd~ zMI$HcXwRKA6SA=kV6YtVxJd6^1f6Uh-~pk`WEK&dBTR)qsqd+Pjn0KK-STG629!;> zlK)6q_hB%82j7OekhwyVn_E+4aP#8VlEZyDnHOqI)f@5XgSNJhr%hO2C&8}I9GBoi z8gxu?U%T7%!l513vGKlZQkSo+AS-EWr@4VoD8;85HhN`u0uD%FY`i}8)+ zSrYlqMa+2cTEAku8UFMl@4C3bXpb78T!PXb(~XJdavyv+Vq%L~`{uy9Rp-Nw8Mks* zm{)7{J*u%-1Zx1R7d<1R97)EX1k~D)1I9aR%62E5;WS+e3IY2Gy0p07I z-7Vyhls=w(**aMaH_WVb;n=0Lr6yt`iSEv{O$2`Mx_ z)G>UwZY;a>rFOiA^j_hEU@`Pp$(Z+x8w+_iePu+|Am@Usd$F#t4~mxHP~C@Q;=MNG zQ{?nl(NHoWFXxqrdH432nnQ4C^(g737v?jq@}u(5G@`xf6o;%SFLmgd?;plypa&>D z`Q-BZK@Gj)J&vK)8g<0^pW3hLHRl<^q*uY%C-W_8m1~$Y+79(9LWv9v zN{JBmzrKHbDg@Yv`2Zs2Ww>fpp_-WxqIZp>b`}|aHP*sA3U0v02eh{!FnIyuG0(N} z!L@eSe-Yv_WG(NxxV#-I5S`%aUIKu<`SjpQW`rbukj2goz)=(`&(Xk0O?C!^TVV)M zDD!$I!K90+wwyD>YJ*W)MG|c~{Soj1%e`Nm;Lf8z8r52W)*>bIZ`{W`#W4v+U8hnQ zBt(;R3`_H2fv0KEkl&M5i=v031}4z!7z-wKXl>MOI-)6+*{bu5h+3t16_E@TP|vj9 zxiMl=H;PcDFUQj5C|y^>ZA1_3jCz2jgwkPzCS`!?;3CL&DKou)PWf0{&6as7Do*4twB;HqmWc_dKF6l+Qw0VxWo zG<)FhQov42XQ-VTEjBWPODqTFQ1hRNb~cPzGq_LtS2aYl)EG;N;04DEkhM@$r)H%T zD~m$udgnoBB9xeB8btoMYxV5FE2W2oq9U0n1rgvL=#=4NZ8TvgiFQSV_6A=Ml!+Pb zvOUJwB7=$2CnzBGez3j}sCJM~37jt%V?sY@YCbq0T|G#`SxvV7_WJ_tB08kn<_{VU z!wuY-rsoe)U)ngz^`RIg+D9Z;<=_>oS@5`0J)K~SSAYN+m1OQ#oIpJ z@-!EOhmiP{8Dv`gV^AN$dyuGuaNvz_7T_**?{ovuGg!EGMKiI+b=}9GdNPbwm$B?L#LH(q_u5%H zd~yNC3$a6y**k*_T(wWYAYAQ&FDbwVo2hl+@W%mJFZNS?17qYwjN0XDmib z4Y1uCP7a3AQ6HpH{-c-Q98_Er-)m|`*(Au-)S^nXdmRV5Q%-3oFms0ptEP@z2l_|h zx?Q)rq~?fi{nGUIKO^7&7TL(cCX8BX219^m8n+R$jADFRks0?XIcGEUQlX)NpiZwy zTk{Um3%1t@m&hGac4H_F8Kld^qlwgZ+NPEHGXjbXEROP`k@RdIsN2<~ zXv65`A5xv1B8QuEvAx>nMaEGqlc$C#9T@cjp`>dq_8dz#p`@rpxu(w7yO(b{O$EOi zp%)Z`=T(6HDY?B4Rr+j;UOAw8g%Jh7Bo63@VI7z@hjOV4v`~uy&?0U8t0m4zDO7>c zEW;&gXAGt$pg>KOh7vk))ChP%?->=lU9cD}v*?w2k)*CA zMq4&GB~Jkq8L`=?Al<%e^OCOdLbynSZmOz;+B0&-&TN>P@GkBJdx=1dx1XL(^1o-5XP84t)&mQyrB3kf31K?m3GYmpAz z8?^XmEF&s50Sllq6HF9D5^s_s=t=pS{E78<>KXTn)N7mOg~WlSa!7L`H(8?5RLU6@ QL@27zrbzKJG9E1Z7pj}NRsaA1 literal 0 HcmV?d00001 From ac916031d70bfb1a63d5a84c1d583808118a88fd Mon Sep 17 00:00:00 2001 From: Geo Date: Wed, 6 Jul 2016 01:09:01 -0400 Subject: [PATCH 2/3] Fix markdown syntax --- eggdrop/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eggdrop/content.md b/eggdrop/content.md index aa7e30a2be61..0f513758bda5 100644 --- a/eggdrop/content.md +++ b/eggdrop/content.md @@ -1,6 +1,6 @@ # What is Eggdrop? -Eggdrop is the world's most popular Open Source IRC bot, designed for flexibility and ease of use, and is freely distributable under the GNU General Public License (GPL). It is designed to Linux, *BSD, SunOs, Windows, and Mac OS X, among others. The core codebase is extendable via TCL scripts or C modules and bots can be linked to form botnets, enabling the sharing of userfiles and partylines across multiple bots. +Eggdrop is the world's most popular Open Source IRC bot, designed for flexibility and ease of use, and is freely distributable under the GNU General Public License (GPL). It is designed to Linux, BSD, SunOs, Windows, and Mac OS X, among others. The core codebase is extendable via TCL scripts or C modules and bots can be linked to form botnets, enabling the sharing of userfiles and partylines across multiple bots. %%LOGO%% From 86044eabede7a8db9627afe3a8cb783195f6576c Mon Sep 17 00:00:00 2001 From: Geo Date: Fri, 29 Jul 2016 22:56:43 -0400 Subject: [PATCH 3/3] Update content.md --- eggdrop/content.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/eggdrop/content.md b/eggdrop/content.md index 0f513758bda5..48d1310a8c0e 100644 --- a/eggdrop/content.md +++ b/eggdrop/content.md @@ -10,7 +10,7 @@ Eggdrop is the world's most popular Open Source IRC bot, designed for flexibilit To run this container the first time, you'll need to pass in, at minimum, a nickname and server via Environmental Variables. At minimum, a docker run command similar to - docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net eggheads/eggdrop:latest + docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/for/host/data:/home/eggdrop/eggdrop/data eggdrop:latest should be used. This will modify the appropriate values within the config file, then start your bot with the nickname FooBot and connect it to irc.freenode.net. @@ -18,9 +18,11 @@ These variables are only needed for your first run- after the first use, you can ## Long-term Persistence -After running the eggdrop container for the first time, the configuration file, user file and channel file will all be available inside the container at /home/eggdrop/eggdrop/data/ . NOTE! These files are only as persistent as the container they exist in. If you expect to use a different container over the course of using the Eggdrop docker image (intentionally or not) you will want to create a persistent data store. The easiest way to do this is to mount a directory on your host machine to /home/eggdrop/eggdrop/data. If you do this prior to your first run, you can easily edit the eggdrop configuration file on the host. Otherwise, you can also drop in existing config, user, or channel files into the mounted directory for use in the eggdrop container. To do this, start your container with something similar to +After running the eggdrop container for the first time, the configuration file, user file and channel file will all be available inside the container at /home/eggdrop/eggdrop/data/ . NOTE! These files are only as persistent as the container they exist in. If you expect to use a different container over the course of using the Eggdrop docker image (intentionally or not) you will want to create a persistent data store. The easiest way to do this is to mount a directory on your host machine to /home/eggdrop/eggdrop/data. If you do this prior to your first run, you can easily edit the eggdrop configuration file on the host. Otherwise, you can also drop in existing config, user, or channel files into the mounted directory for use in the eggdrop container. You'll also likely want to daemonize eggdrop (ie, run it in the background). To do this, start your container with something similar to - docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data eggdrop + docker run -i -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data -d eggdrop:latest + +Please note that, even in daemon mode, the -i flag for docker run is required. ## Exposing network ports