From 6fb07a8dacbad5cc548b87e4c267823a4aa98660 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Mon, 23 Jan 2017 15:55:15 +0100 Subject: [PATCH 01/12] Add documentation for the xwiki official image --- xwiki/README-short.txt | 1 + xwiki/README.md | 127 +++++++++++++++++++++++++++++++++++++++++ xwiki/content.md | 116 +++++++++++++++++++++++++++++++++++++ xwiki/github-repo | 1 + xwiki/license.md | 1 + xwiki/logo.png | Bin 0 -> 4773 bytes xwiki/mailing-list.md | 1 + 7 files changed, 247 insertions(+) create mode 100644 xwiki/README-short.txt create mode 100644 xwiki/README.md create mode 100644 xwiki/content.md create mode 100644 xwiki/github-repo create mode 100644 xwiki/license.md create mode 100644 xwiki/logo.png create mode 100644 xwiki/mailing-list.md diff --git a/xwiki/README-short.txt b/xwiki/README-short.txt new file mode 100644 index 000000000..d11812cab --- /dev/null +++ b/xwiki/README-short.txt @@ -0,0 +1 @@ +XWiki: The Advanced Open Source Enterprise Wiki. \ No newline at end of file diff --git a/xwiki/README.md b/xwiki/README.md new file mode 100644 index 000000000..910997aa6 --- /dev/null +++ b/xwiki/README.md @@ -0,0 +1,127 @@ +# Supported tags and respective `Dockerfile` links + +- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) +- [`8` (*6-jre-1.7.4-plume/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) +- [`latest-mysql-tomcat` (*6-jre-1.7.4-plus/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) +- [`8-mysql-tomcat` (*6-jre-1.7.4-webprofile/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) + +For more information about this image and its history, please see [the relevant manifest file (`library/xwiki`)](https://github.com/docker-library/official-images/blob/master/library/tomee). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fxwiki). + +For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see [the `repos/xwiki/tag-details.md` file](https://github.com/docker-library/repo-info/blob/master/repos/xwiki/tag-details.md) in [the `docker-library/repo-info` GitHub repo](https://github.com/docker-library/repo-info). + +# What is XWiki + +[XWiki](http://xwiki.org) is a free wiki software platform written in Java with a design emphasis on extensibility. XWiki is an enterprise wiki. It includes WYSIWYG editing, OpenDocument based document import/export, semantic annotations and tagging, and advanced permissions management. + +As an application wiki, XWiki allows for the storing of structured data and the execution of server side script within the wiki interface. Scripting languages including Velocity, Groovy, Python, Ruby and PHP can be written directly into wiki pages using wiki macros. User-created data structures can be defined in wiki documents and instances of those structures can be attached to wiki documents, stored in a database, and queried using either Hibernate query language or XWiki's own query language. + +[XWiki.org's extension wiki](http://extensions.xwiki.org) is home to XWiki extensions ranging from [code snippets](http://snippets.xwiki.org) which can be pasted into wiki pages to loadable core modules. Many of XWiki Enterprise's features are provided by extensions which are bundled with it. + +![logo](http://www.xwiki.org/xwiki/bin/view/Main/Logo?xpage=plain&act=svg&finput=logo-xwikiorange.svg&foutput=logo-xwikiorange.png&width=200) + +# How to use this image + +You should first install [Docker](https://www.docker.com/) on your machine. + +Then there are several options: + +1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. +2. Just pull the xwiki image from DockerHub. + +## Building ## + +This is the simplest solution and the one recommended. Here are the steps: + +* Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from +the GitHub UI. Then choose the branch or tag that you wish to use: + * The `master`branch will get you the latest released version of XWiki + * The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle + * The `8.4.4` tag will get you exactly XWiki 8.4.4. + * etc. +* Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. +* Run `docker-compose up` +* Start a browser and point it to `http://localhost:8080` + +Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the +values you need in there. It's also possible to override them on the command line with +`docker-compose run -e "XWIKI_VERSION=8.4.4"`. + +Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it +you can issue `docker-compose up --build`. You can also build the image with +`docker build . -t xwiki-mysql-tomcat:latest` for example. + +## Pulling existing image ## + +This is a bit more complex since you need to have 2 docker containers running: one for XWiki and one for the database. + +Here's a minimal Docker Compose file using MySQL that you could use as an example (full example +[here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml): + +``` +version: '2' +services: + web: + image: "xwiki/xwiki-mysql-tomcat:latest" + depends_on: + - db + ports: + - "8080:8080" + volumes: + - xwiki-data:/var/lib/xwiki + environment: + - MYSQL_USER=xwiki + - MYSQL_PASSWORD=xwiki + db: + image: "mysql:5" + volumes: + - ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf + - mysql-data:/var/lib/mysql + environment: + - MYSQL_ROOT_PASSWORD=xwiki + - MYSQL_USER=xwiki + - MYSQL_PASSWORD=xwiki + - MYSQL_DATABASE=xwiki +volumes: + mysql-data: {} + xwiki-data: {} +``` + +# Details for xwiki-mysql-tomcat + +## Configuration Options + +The first time you create a container out of the xwiki image, a shell script (/usr/local/bin/start_xwiki.sh`) is +executed in the container to setup some configuration. The following environment variables can be passed: + +* `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. +* `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. + +## Miscellaneous + +Volumes: +* Two volumes are created: + * A volume named `_mysql-data` that contains the database data. + * A volume named `_xwiki-data` that contains XWiki's permanent directory. +* To find out where those volumes are located on your local host machine you can inspect them with `docker volume inspect `. To find the volume name, you can list all volumes with `docker volume ls`. +* Note that on Mac OSX, Docker runs inside the xhyve VM and thus the paths you get when inspecting the volumes are relative to this. Thus, you need to get into that VM if you need to access the volume data. + +MySQL: +* To issue some mysql commands: + * Find the container id with `docker ps` + * Execute bash in the mysql container: `docker exec -it bash -l` + * Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` + +# License + +XWiki is licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). + +This repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). + +# Support + +* If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) +* If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) + +# Contribute + +* If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) diff --git a/xwiki/content.md b/xwiki/content.md new file mode 100644 index 000000000..0eb5f22c6 --- /dev/null +++ b/xwiki/content.md @@ -0,0 +1,116 @@ +# What is XWiki + +[XWiki](http://xwiki.org) is a free wiki software platform written in Java with a design emphasis on extensibility. XWiki is an enterprise wiki. It includes WYSIWYG editing, OpenDocument based document import/export, semantic annotations and tagging, and advanced permissions management. + +As an application wiki, XWiki allows for the storing of structured data and the execution of server side script within the wiki interface. Scripting languages including Velocity, Groovy, Python, Ruby and PHP can be written directly into wiki pages using wiki macros. User-created data structures can be defined in wiki documents and instances of those structures can be attached to wiki documents, stored in a database, and queried using either Hibernate query language or XWiki's own query language. + +[XWiki.org's extension wiki](http://extensions.xwiki.org) is home to XWiki extensions ranging from [code snippets](http://snippets.xwiki.org) which can be pasted into wiki pages to loadable core modules. Many of XWiki Enterprise's features are provided by extensions which are bundled with it. + +![logo](http://www.xwiki.org/xwiki/bin/view/Main/Logo?xpage=plain&act=svg&finput=logo-xwikiorange.svg&foutput=logo-xwikiorange.png&width=200) + +# How to use this image + +You should first install [Docker](https://www.docker.com/) on your machine. + +Then there are several options: + +1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. +2. Just pull the xwiki image from DockerHub. + +## Building ## + +This is the simplest solution and the one recommended. Here are the steps: + +* Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from +the GitHub UI. Then choose the branch or tag that you wish to use: + * The `master`branch will get you the latest released version of XWiki + * The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle + * The `8.4.4` tag will get you exactly XWiki 8.4.4. + * etc. +* Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. +* Run `docker-compose up` +* Start a browser and point it to `http://localhost:8080` + +Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the +values you need in there. It's also possible to override them on the command line with +`docker-compose run -e "XWIKI_VERSION=8.4.4"`. + +Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it +you can issue `docker-compose up --build`. You can also build the image with +`docker build . -t xwiki-mysql-tomcat:latest` for example. + +## Pulling existing image ## + +This is a bit more complex since you need to have 2 docker containers running: one for XWiki and one for the database. + +Here's a minimal Docker Compose file using MySQL that you could use as an example (full example +[here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml): + +``` +version: '2' +services: + web: + image: "xwiki/xwiki-mysql-tomcat:latest" + depends_on: + - db + ports: + - "8080:8080" + volumes: + - xwiki-data:/var/lib/xwiki + environment: + - MYSQL_USER=xwiki + - MYSQL_PASSWORD=xwiki + db: + image: "mysql:5" + volumes: + - ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf + - mysql-data:/var/lib/mysql + environment: + - MYSQL_ROOT_PASSWORD=xwiki + - MYSQL_USER=xwiki + - MYSQL_PASSWORD=xwiki + - MYSQL_DATABASE=xwiki +volumes: + mysql-data: {} + xwiki-data: {} +``` + +# Details for xwiki-mysql-tomcat + +## Configuration Options + +The first time you create a container out of the xwiki image, a shell script (/usr/local/bin/start_xwiki.sh`) is +executed in the container to setup some configuration. The following environment variables can be passed: + +* `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. +* `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. + +## Miscellaneous + +Volumes: +* Two volumes are created: + * A volume named `_mysql-data` that contains the database data. + * A volume named `_xwiki-data` that contains XWiki's permanent directory. +* To find out where those volumes are located on your local host machine you can inspect them with `docker volume inspect `. To find the volume name, you can list all volumes with `docker volume ls`. +* Note that on Mac OSX, Docker runs inside the xhyve VM and thus the paths you get when inspecting the volumes are relative to this. Thus, you need to get into that VM if you need to access the volume data. + +MySQL: +* To issue some mysql commands: + * Find the container id with `docker ps` + * Execute bash in the mysql container: `docker exec -it bash -l` + * Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` + +# License + +XWiki is licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). + +This repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). + +# Support + +* If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) +* If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) + +# Contribute + +* If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) diff --git a/xwiki/github-repo b/xwiki/github-repo new file mode 100644 index 000000000..6e64874c5 --- /dev/null +++ b/xwiki/github-repo @@ -0,0 +1 @@ +https://github.com/xwiki-contrib/docker-xwiki \ No newline at end of file diff --git a/xwiki/license.md b/xwiki/license.md new file mode 100644 index 000000000..0a13f905b --- /dev/null +++ b/xwiki/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE) for the software contained in this image. diff --git a/xwiki/logo.png b/xwiki/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9327e79ec3932aea31f71a388d902a646fa0ef2e GIT binary patch literal 4773 zcmV;W5?bwvP)004R> z004l5008;`004mK004C`008P>0026e000+ooVrmw00004XF*Lt006O$eEU(800001 zb5ch_0Itp)=>Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01m_e01m_fl`9S#000sE zNkl_Xe)ryU@7%cegTXj+|D1on^Zox0Kuj^k6jMww#S~Laiit&`5q)1k)t&p$&l$9E z4xVK$zgm?}+GQD}q-j(s{}8SF{j*T3EyPftvhrbHAPft+IrTVt>_o|>4J z9S7;|?ykOb=gwx%Sp#Eyl5;+q&*uwK>=?GSQ22hU0NZ*Yw%tml68XWwL9*D!d!Y$5 zs25wv1XRNq>w|?rH;G<-Q)m?Lyupq_KHzte`^J03=9Pp7Y!}qP2xT0++~d1XZ^0(u zqE7(hV*IYFY9Cn#$!4<~1TZd%KkF8KeG5Qq6(G6cr*m&yhHpxqJ9T^;Jm>X!*j7zr zg9whrZ57{TFJ2rTCk*zW_@{HxS3|G@b_6xi`~aL3GqGpUR|DdGyMlP1o4$D&hp@-a zd}qJ-XWya?|2X>q_N!MOC%>jX>4QJK?_gJ_yc1?3=#JT3vf@sW|NS9tC|mfqQI;H1vk} zUP+%w06|ej{IgE-^IFammz@?~7=&%mG_V5lB0wkYCri`Wv=uc5(r5<1ll<~)^{YwJ z2X4`46hW+4Ouh8^UheS+jy}=$eL?n#sHF1^wsWlS)+~pdrjj~`=njg24Gw)-=kTa0 z$@d$TPjDYp>)gVcdd2Umt&AI8_Bpa7M5T8G2;Q^V46cP}#bOhLYnoE;-|*s4E3X zI{ox0WtTzo?CRBPPKGa9wZ9|YzLRk2Er8;PZ6A)}HE`SFr)Px>`>fK2C*U^@zrU<( zQ5kKw5moQ_VSVbN zFvyNV!#v7bEya&APQs3fg_{X_z_Quwb}?-IK=S9Xy%ZC#Nng8CLcP$OZcTAAY}CSi zMemf0h|5B}GA⪼J9XjV@~CJU3tO)H%FLyiS#vC2RY?mxWlB(ES(HQgAFlRy8}RVRy*T~(2yE|kn#pqh=DE@r7Pd~8^b3c3ys zL#(m~#~)!ji1&Mn#meP|djtUfN&v~T=p$)uZCz`3-KrI^Ux4HzGz186oWf{c*|l9= zT|(JRd;xM_$70IQ%zXQ{+y0q@T?kN7@3filvUmD*8uH%*j=z<8dlqUe4HD52t2o$6 z2~$CW1HeZ#@6611dsnSmvq6BM(E%julgTHph=u*4EEcM-S=Vb`H$PG`;;ZhQ6Hldp z<61iX%#M8iytfbs4%fjtXcD=|h|h8Vtvkf()-LZmeG2MDf2`*EdKht19y!NW(Plfb zY7#VP4iX%mISA6&*w_MN+BWeg!AHXD=jV%qetjf{uY)xaE}crHl3i$h^ZYUf<3T9u zV&dzdJPhU`DECXg@APHOl8c5nA_|Ts(dL{jI5=!!$Aag6zQWxNld0A!#3ILrqK_n< zUeoXOU2SdI_ldraX-!LR5!}k(;4%18ve;hmIp*CG&OI)~osVRqolrmhh*=vYef&=Z z#j1J-a1_L<&4%T>@tqGMKr&@=5{iFeUnbN3hI@-uN3T$}d!4OSFvl3rUc5MX)Az_| zQqH&`5bG6(v!=K+;_5y>3Ob9Hg06!j0at8{F9?pGv-iXE-6%blBif1`wnR7tRlfWwoDp`RTT{4#)8EOeRy$IXee*Ux(U6BiRm{^vFe+ z)TeRdk+S&|T-6tYm6-K|hfK?q-quJf=(^cE0hesRaa;WUV%XqN3J`;n45JKvkZ@_0 z5QTCtz0@I9crmZTjLuz2;2iFK9W-%hQu4j)@NIMV@0I}P?~ndOXBU@b6ei(U9z;c% zcom5d6VqscX8T&nC1_~rssuQc1H=Hy`93lF6f@|`M1o)G=;&B)!8y{!qRwt>2}3;K z#n(Xu$d{5|e&PCAMp91NaskZ2rzNxUnWR1Ltyv6y>9TL(at^M~vn&MxIouZZLFII% zK#De`Qi&Y^K#6-2K;V}R=bvff(epZ3j>$}+OK1N^Dpj=?P0j(0&$u#0ok5#yPhrPP zbe(D#lZsjHtyvo+Gha~?udc^2_@@mxkaILw5*&d6#Bc~|Tg0CfC9rOOzL*mr(M745 znY$koeH|0U;`|mjg%~_4>Qk1Ax{ICMjNI*%{QP;@dr>#wFeKUeUv=@`YRLke6AJoN z#lV5>O29dgM?>I-x2w|N2n-;GsHOWzwg4@Uq;X-P_%ZrA#NXQqkDpE^S=XgYm!^ZC zO^NI~M@i0lBwlTm=u&g=qr|M6fMLng=+-QQ+gSQsf(Yy*gX5m==djxZUlHK=GzvOW zpmnhf9|?bjm`Bn{@pXWa*RgGQcsLxTjY&iiH;TI4dNougUOl|!h>bOiS_DCpih|=6 z1&3YTGcFYJh=3z-fFPk?LMY>1$_AOkE*E(nDmchjeiU`nXVM}8&fgqvml->#1s!Bw z|F0qnj{QQc9fAl^D3uijNN}Qe`QFSKd)x50gh)xLd6A~58zQ5Xm~&e!nQIQd?bGhLoVGodLf1mcOsLREx zQAbBzjh+|dDK<-Qo3$ly7M`L6m@4JM@7WkBaEuNLk@6Hoke2RjeP2|;lPmj0i(M4@ z;-m0mO%L=vKT7~fUnbMBQQYIQkQf^&6uu>cOIKp&pkGW(3vmKR#bWHS$z?`8WV1w3 zzbbufFRYVB(sKBVW3PoG%?}8XgTZSS_hZQXmgwt+%*4eG#@z3A+(W5Ld*yLba*tDv z`pc60&XRZWYN<7At%Eh|1y^9N1g#LFRYViEBmm(aGv)XworCB}Pn%pkyaDfVm2Aa4 zWc=CX!OOkQQa!+o+^v`F?&R^(7Z8(}J>}kcdE1JWG4Vvn!fJ|{exL9y2;3iG$;<=htp!r zc1Ka%3dPK8Bt5Yc3P$rp7zOF1JHPe!mAk>_oUvm+j}_!4kd@=KG& z!jgH=D^?_q9fjS?5hQ^E#K`qX*yR{6Uit&#bHQ2ELYZ5`f^_vE1LV5o`-U>{N@m{W zKP5)Fe*F>M=V4W-pgcB97AMAS{3bC-!UYH>JuNKo9LUos7th>SI=yPQ_+YJF$|MTF zC2~#$>6A{cvGZFw64x)8P~)^Ft3L3i_OQf5prEEH{t@0uVIG zVnsz-(i7Y)78mpyRz@8wo&{R8XJpU(3cZP0s#n~5#m&F(Ih+sbj#wrjzxJS6j{Ate!h4*v_pI3ih6@7UdfL% z;8Kq`ePJ01L{?(f+DGRMYEp-1q>ectg5={$gG4z%ve}Mfct!}}(pmF_+^NzZ5G08N zG!qNbZBM7ygaZegHdu+9(t&ry z!Y8LxVlg-Yl6OfPyv7FYYHcYZD_Oo;^!zP}cy-$hI8;fpf)0nkD)*hk%}V8ycc{YLK*H zS)4;i07=FKN%gV-h~bCO9f5U(%g3L1BH=mqUjS>r;Y@S{iGFC$;#ymZ$(=Wv!Jh(H zNGN8xsp#@ASSF-{1R(DKl5=5k63+m^0&mG=6^d2s2$xS3ix0N>tzm`EL?HM`5F`&C z6bFqWbgF02RW$5)U?np-(CZLuk&57TrWJriKF$z0NmXP4LM`xSm}<3F6*a8Tk(f#) z@ub};!sVL^g}djJn|}>umnzQ>2RL)|XD62zKu{!QALvCs>_Ku5E}6ckXaOXXY40Nz zcq<6K!_wEWbTfo1@i`$r--ypiZlli_2jghXM37`$<&n@P55YlOa2y5#n>l%=VQCvC z*pbRrQS`}4cH1VuVHRk>&P3M$X=`goC*U6lmo5l!bP;PrA#FeUTPFB$$6+Mzwz_G~u0NzuZjh**IaxHDt3ZaV;V5*`C0ShqF@5tc#% z2wHlK@gEe7_ZFzK*Nu^fN)8*C7Fk?tG+}J!=7yzQa-UTrv_*5&wg}%;)ay=p^q>pb6wAzA1^Lbpi8-S$KPh&%FS}VVBTho%w7@l6~ zfiv?+kOj+jchSb8n%$jAfS3rudQ}ceS*GE2&(D+5qR<9U}VnQMxdHLl2VY|(lnMeG8Pp~5EfD3WfjSXDiKz$$7Yqc zWxzay$E%(-0_B#tAv^KW%RPQ|5*;Mv`lsbQc?f}?-8;$*2Kac@hQUb z3e;yNp+SEpv439f@!ih1^f_qIIfnp;-8;8e=uM&qf8DGC&o z0$mTi;VmXOdg7^xDW;fWiYca;Vu~rI$CCaB1+yqUY91Vg00000NkvXXu0mjfgDvj$ literal 0 HcmV?d00001 diff --git a/xwiki/mailing-list.md b/xwiki/mailing-list.md new file mode 100644 index 000000000..a45796506 --- /dev/null +++ b/xwiki/mailing-list.md @@ -0,0 +1 @@ +For general questions about XWiki, see our [user mailing list](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists). From 6bb3615976935c30239d443625e19870d851489c Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Fri, 27 Jan 2017 19:10:17 +0100 Subject: [PATCH 02/12] Update sha1 + fix typos --- xwiki/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xwiki/README.md b/xwiki/README.md index 910997aa6..955080151 100644 --- a/xwiki/README.md +++ b/xwiki/README.md @@ -1,9 +1,9 @@ # Supported tags and respective `Dockerfile` links -- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) -- [`8` (*6-jre-1.7.4-plume/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) -- [`latest-mysql-tomcat` (*6-jre-1.7.4-plus/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) -- [`8-mysql-tomcat` (*6-jre-1.7.4-webprofile/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/f12105946de0ec0fe2b319ddd5a1c2c807bf00fb/xwiki-mysql-tomcat/Dockerfile) +- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/1f845295f650ce5c755712b801b84ad8198b9d7b/xwiki-mysql-tomcat/Dockerfile) +- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/e8ad90aa6d119301bd4b810a88ed71b2f8a0e224/xwiki-mysql-tomcat/Dockerfile) +- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/1f845295f650ce5c755712b801b84ad8198b9d7b/xwiki-mysql-tomcat/Dockerfile) +- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/e8ad90aa6d119301bd4b810a88ed71b2f8a0e224/xwiki-mysql-tomcat/Dockerfile) For more information about this image and its history, please see [the relevant manifest file (`library/xwiki`)](https://github.com/docker-library/official-images/blob/master/library/tomee). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fxwiki). From 7474ccafddf033f07950e308af8e9ae52f06d980 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Mon, 30 Jan 2017 11:56:53 +0100 Subject: [PATCH 03/12] Update to latest sha1s --- xwiki/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xwiki/README.md b/xwiki/README.md index 955080151..042b05963 100644 --- a/xwiki/README.md +++ b/xwiki/README.md @@ -1,9 +1,9 @@ # Supported tags and respective `Dockerfile` links -- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/1f845295f650ce5c755712b801b84ad8198b9d7b/xwiki-mysql-tomcat/Dockerfile) -- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/e8ad90aa6d119301bd4b810a88ed71b2f8a0e224/xwiki-mysql-tomcat/Dockerfile) -- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/1f845295f650ce5c755712b801b84ad8198b9d7b/xwiki-mysql-tomcat/Dockerfile) -- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/e8ad90aa6d119301bd4b810a88ed71b2f8a0e224/xwiki-mysql-tomcat/Dockerfile) +- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/52b982b1c18ed06b87b20d33c677a3efb7b361f6/xwiki-mysql-tomcat/Dockerfile) +- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/56aa09e5859e22b370a950ec08f9c3a04067915e/xwiki-mysql-tomcat/Dockerfile) +- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/52b982b1c18ed06b87b20d33c677a3efb7b361f6/xwiki-mysql-tomcat/Dockerfile) +- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/56aa09e5859e22b370a950ec08f9c3a04067915e/xwiki-mysql-tomcat/Dockerfile) For more information about this image and its history, please see [the relevant manifest file (`library/xwiki`)](https://github.com/docker-library/official-images/blob/master/library/tomee). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fxwiki). From 76e85b255528e2a2054c4a1d6017d58d39749dd8 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Wed, 1 Feb 2017 16:23:48 +0100 Subject: [PATCH 04/12] Update to latest sha1 --- xwiki/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xwiki/README.md b/xwiki/README.md index 042b05963..9915a5d71 100644 --- a/xwiki/README.md +++ b/xwiki/README.md @@ -1,9 +1,9 @@ # Supported tags and respective `Dockerfile` links -- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/52b982b1c18ed06b87b20d33c677a3efb7b361f6/xwiki-mysql-tomcat/Dockerfile) -- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/56aa09e5859e22b370a950ec08f9c3a04067915e/xwiki-mysql-tomcat/Dockerfile) -- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/52b982b1c18ed06b87b20d33c677a3efb7b361f6/xwiki-mysql-tomcat/Dockerfile) -- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/56aa09e5859e22b370a950ec08f9c3a04067915e/xwiki-mysql-tomcat/Dockerfile) +- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/6c386ede3706ca0bff2a65d6559e15497d8e4a30/xwiki-mysql-tomcat/Dockerfile) +- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/44b586d58e03d569c731519edfb6f6e7175d5c82/xwiki-mysql-tomcat/Dockerfile) +- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/6c386ede3706ca0bff2a65d6559e15497d8e4a30/xwiki-mysql-tomcat/Dockerfile) +- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/44b586d58e03d569c731519edfb6f6e7175d5c82/xwiki-mysql-tomcat/Dockerfile) For more information about this image and its history, please see [the relevant manifest file (`library/xwiki`)](https://github.com/docker-library/official-images/blob/master/library/tomee). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fxwiki). From c0e5710772bbf159795dda85cf0aa0668f972964 Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Tue, 7 Feb 2017 14:52:15 -0800 Subject: [PATCH 05/12] Adjust whitespace for markdownfmt --- xwiki/content.md | 72 +++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 38 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index 0eb5f22c6..163ef6a2d 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -14,39 +14,33 @@ You should first install [Docker](https://www.docker.com/) on your machine. Then there are several options: -1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. -2. Just pull the xwiki image from DockerHub. +1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. +2. Just pull the xwiki image from DockerHub. -## Building ## +## Building This is the simplest solution and the one recommended. Here are the steps: -* Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from -the GitHub UI. Then choose the branch or tag that you wish to use: - * The `master`branch will get you the latest released version of XWiki - * The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle - * The `8.4.4` tag will get you exactly XWiki 8.4.4. - * etc. -* Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. -* Run `docker-compose up` -* Start a browser and point it to `http://localhost:8080` +- Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from the GitHub UI. Then choose the branch or tag that you wish to use: + - The `master`branch will get you the latest released version of XWiki + - The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle + - The `8.4.4` tag will get you exactly XWiki 8.4.4. + - etc. +- Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. +- Run `docker-compose up` +- Start a browser and point it to `http://localhost:8080` -Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the -values you need in there. It's also possible to override them on the command line with -`docker-compose run -e "XWIKI_VERSION=8.4.4"`. +Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the values you need in there. It's also possible to override them on the command line with `docker-compose run -e "XWIKI_VERSION=8.4.4"`. -Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it -you can issue `docker-compose up --build`. You can also build the image with -`docker build . -t xwiki-mysql-tomcat:latest` for example. +Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it you can issue `docker-compose up --build`. You can also build the image with `docker build . -t xwiki-mysql-tomcat:latest` for example. -## Pulling existing image ## +## Pulling existing image This is a bit more complex since you need to have 2 docker containers running: one for XWiki and one for the database. -Here's a minimal Docker Compose file using MySQL that you could use as an example (full example -[here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml): +Here's a minimal Docker Compose file using MySQL that you could use as an example (full example [here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml)): -``` +```yaml version: '2' services: web: @@ -79,26 +73,28 @@ volumes: ## Configuration Options -The first time you create a container out of the xwiki image, a shell script (/usr/local/bin/start_xwiki.sh`) is -executed in the container to setup some configuration. The following environment variables can be passed: +The first time you create a container out of the xwiki image, a shell script (`/usr/local/bin/start_xwiki.sh`) is executed in the container to setup some configuration. The following environment variables can be passed: -* `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. -* `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. +- `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. +- `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. ## Miscellaneous Volumes: -* Two volumes are created: - * A volume named `_mysql-data` that contains the database data. - * A volume named `_xwiki-data` that contains XWiki's permanent directory. -* To find out where those volumes are located on your local host machine you can inspect them with `docker volume inspect `. To find the volume name, you can list all volumes with `docker volume ls`. -* Note that on Mac OSX, Docker runs inside the xhyve VM and thus the paths you get when inspecting the volumes are relative to this. Thus, you need to get into that VM if you need to access the volume data. + +- Two volumes are created: + - A volume named `_mysql-data` that contains the database data. + - A volume named `_xwiki-data` that contains XWiki's permanent directory. +- To find out where those volumes are located on your local host machine you can inspect them with `docker volume inspect `. To find the volume name, you can list all volumes with `docker volume ls`. + +- Note that on Mac OSX, Docker runs inside the xhyve VM and thus the paths you get when inspecting the volumes are relative to this. Thus, you need to get into that VM if you need to access the volume data. MySQL: -* To issue some mysql commands: - * Find the container id with `docker ps` - * Execute bash in the mysql container: `docker exec -it bash -l` - * Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` + +- To issue some mysql commands: + - Find the container id with `docker ps` + - Execute bash in the mysql container: `docker exec -it bash -l` + - Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` # License @@ -108,9 +104,9 @@ This repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-c # Support -* If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) -* If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) +- If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) +- If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) # Contribute -* If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) +- If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) From b1e5df58cee8b5e3e89e943cca36ce5ad740fa03 Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Tue, 7 Feb 2017 15:38:51 -0800 Subject: [PATCH 06/12] Move some of content.md to use license.md and user-feedback.md Also drop README.md since it will be generated --- xwiki/README.md | 127 ----------------------------------------- xwiki/content.md | 15 ----- xwiki/license.md | 4 +- xwiki/user-feedback.md | 12 ++++ 4 files changed, 15 insertions(+), 143 deletions(-) delete mode 100644 xwiki/README.md create mode 100644 xwiki/user-feedback.md diff --git a/xwiki/README.md b/xwiki/README.md deleted file mode 100644 index 9915a5d71..000000000 --- a/xwiki/README.md +++ /dev/null @@ -1,127 +0,0 @@ -# Supported tags and respective `Dockerfile` links - -- [`latest` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/6c386ede3706ca0bff2a65d6559e15497d8e4a30/xwiki-mysql-tomcat/Dockerfile) -- [`8` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/44b586d58e03d569c731519edfb6f6e7175d5c82/xwiki-mysql-tomcat/Dockerfile) -- [`mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/6c386ede3706ca0bff2a65d6559e15497d8e4a30/xwiki-mysql-tomcat/Dockerfile) -- [`8-mysql-tomcat` (*xwiki-mysql-tomcat/Dockerfile*)](https://github.com/xwiki-contrib/docker-xwiki/blob/44b586d58e03d569c731519edfb6f6e7175d5c82/xwiki-mysql-tomcat/Dockerfile) - -For more information about this image and its history, please see [the relevant manifest file (`library/xwiki`)](https://github.com/docker-library/official-images/blob/master/library/tomee). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fxwiki). - -For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see [the `repos/xwiki/tag-details.md` file](https://github.com/docker-library/repo-info/blob/master/repos/xwiki/tag-details.md) in [the `docker-library/repo-info` GitHub repo](https://github.com/docker-library/repo-info). - -# What is XWiki - -[XWiki](http://xwiki.org) is a free wiki software platform written in Java with a design emphasis on extensibility. XWiki is an enterprise wiki. It includes WYSIWYG editing, OpenDocument based document import/export, semantic annotations and tagging, and advanced permissions management. - -As an application wiki, XWiki allows for the storing of structured data and the execution of server side script within the wiki interface. Scripting languages including Velocity, Groovy, Python, Ruby and PHP can be written directly into wiki pages using wiki macros. User-created data structures can be defined in wiki documents and instances of those structures can be attached to wiki documents, stored in a database, and queried using either Hibernate query language or XWiki's own query language. - -[XWiki.org's extension wiki](http://extensions.xwiki.org) is home to XWiki extensions ranging from [code snippets](http://snippets.xwiki.org) which can be pasted into wiki pages to loadable core modules. Many of XWiki Enterprise's features are provided by extensions which are bundled with it. - -![logo](http://www.xwiki.org/xwiki/bin/view/Main/Logo?xpage=plain&act=svg&finput=logo-xwikiorange.svg&foutput=logo-xwikiorange.png&width=200) - -# How to use this image - -You should first install [Docker](https://www.docker.com/) on your machine. - -Then there are several options: - -1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. -2. Just pull the xwiki image from DockerHub. - -## Building ## - -This is the simplest solution and the one recommended. Here are the steps: - -* Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from -the GitHub UI. Then choose the branch or tag that you wish to use: - * The `master`branch will get you the latest released version of XWiki - * The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle - * The `8.4.4` tag will get you exactly XWiki 8.4.4. - * etc. -* Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. -* Run `docker-compose up` -* Start a browser and point it to `http://localhost:8080` - -Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the -values you need in there. It's also possible to override them on the command line with -`docker-compose run -e "XWIKI_VERSION=8.4.4"`. - -Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it -you can issue `docker-compose up --build`. You can also build the image with -`docker build . -t xwiki-mysql-tomcat:latest` for example. - -## Pulling existing image ## - -This is a bit more complex since you need to have 2 docker containers running: one for XWiki and one for the database. - -Here's a minimal Docker Compose file using MySQL that you could use as an example (full example -[here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml): - -``` -version: '2' -services: - web: - image: "xwiki/xwiki-mysql-tomcat:latest" - depends_on: - - db - ports: - - "8080:8080" - volumes: - - xwiki-data:/var/lib/xwiki - environment: - - MYSQL_USER=xwiki - - MYSQL_PASSWORD=xwiki - db: - image: "mysql:5" - volumes: - - ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf - - mysql-data:/var/lib/mysql - environment: - - MYSQL_ROOT_PASSWORD=xwiki - - MYSQL_USER=xwiki - - MYSQL_PASSWORD=xwiki - - MYSQL_DATABASE=xwiki -volumes: - mysql-data: {} - xwiki-data: {} -``` - -# Details for xwiki-mysql-tomcat - -## Configuration Options - -The first time you create a container out of the xwiki image, a shell script (/usr/local/bin/start_xwiki.sh`) is -executed in the container to setup some configuration. The following environment variables can be passed: - -* `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. -* `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. - -## Miscellaneous - -Volumes: -* Two volumes are created: - * A volume named `_mysql-data` that contains the database data. - * A volume named `_xwiki-data` that contains XWiki's permanent directory. -* To find out where those volumes are located on your local host machine you can inspect them with `docker volume inspect `. To find the volume name, you can list all volumes with `docker volume ls`. -* Note that on Mac OSX, Docker runs inside the xhyve VM and thus the paths you get when inspecting the volumes are relative to this. Thus, you need to get into that VM if you need to access the volume data. - -MySQL: -* To issue some mysql commands: - * Find the container id with `docker ps` - * Execute bash in the mysql container: `docker exec -it bash -l` - * Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` - -# License - -XWiki is licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). - -This repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). - -# Support - -* If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) -* If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) - -# Contribute - -* If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) diff --git a/xwiki/content.md b/xwiki/content.md index 163ef6a2d..660f57235 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -95,18 +95,3 @@ MySQL: - Find the container id with `docker ps` - Execute bash in the mysql container: `docker exec -it bash -l` - Once inside the mysql container execute the `mysql` command: `mysql --user=xwiki --password=xwiki` - -# License - -XWiki is licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). - -This repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). - -# Support - -- If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) -- If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) - -# Contribute - -- If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](https://github.com/xwiki-contrib/docker-xwiki) diff --git a/xwiki/license.md b/xwiki/license.md index 0a13f905b..1b4f26813 100644 --- a/xwiki/license.md +++ b/xwiki/license.md @@ -1 +1,3 @@ -View [license information](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE) for the software contained in this image. +XWiki is licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). + +The Dockerfile repository is also licensed under the [LGPL 2.1](https://github.com/xwiki-contrib/docker-xwiki/blob/master/LICENSE). diff --git a/xwiki/user-feedback.md b/xwiki/user-feedback.md new file mode 100644 index 000000000..7e5bba5a2 --- /dev/null +++ b/xwiki/user-feedback.md @@ -0,0 +1,12 @@ +## Support + +- If you wish to raise an issue or an idea of improvement use [XWiki Docker JIRA project](http://jira.xwiki.org/browse/XDOCKER) +- If you have questions, use the [XWiki Users Mailing List/Forum](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists) or use the [XWiki IRC channel](http://dev.xwiki.org/xwiki/bin/view/Community/IRC) + +## Contributing + +- If you wish to help out on the code, please send Pull Requests on [XWiki Docker GitHub project](%%GITHUB-REPO%%) + +## Documentation + +Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request. From 8471bd8e871b2a8cfa23536043b3577d82716f7a Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Wed, 8 Feb 2017 11:50:31 +0100 Subject: [PATCH 07/12] Align with documentation at https://github.com/xwiki-contrib/docker-xwiki/blob/master/README.md --- xwiki/content.md | 63 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 44 insertions(+), 19 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index 660f57235..e436c8c47 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -8,8 +8,16 @@ As an application wiki, XWiki allows for the storing of structured data and the ![logo](http://www.xwiki.org/xwiki/bin/view/Main/Logo?xpage=plain&act=svg&finput=logo-xwikiorange.svg&foutput=logo-xwikiorange.png&width=200) +# Introduction + +The goal is to provide a production-ready XWiki system running in Docker. This why: +- The OS is based on Debian and not on some smaller-footprint distribution like Alpine +- Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. + # How to use this image +[![](https://images.microbadger.com/badges/version/xwiki/xwiki-mysql-tomcat.svg)](https://microbadger.com/images/xwiki/xwiki-mysql-tomcat) [![](https://images.microbadger.com/badges/image/xwiki/xwiki-mysql-tomcat.svg)](https://microbadger.com/images/xwiki/xwiki-mysql-tomcat) + You should first install [Docker](https://www.docker.com/) on your machine. Then there are several options: @@ -17,28 +25,20 @@ Then there are several options: 1. Get the [sources of this project](https://github.com/xwiki-contrib/docker-xwiki) and build them. 2. Just pull the xwiki image from DockerHub. -## Building - -This is the simplest solution and the one recommended. Here are the steps: - -- Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from the GitHub UI. Then choose the branch or tag that you wish to use: - - The `master`branch will get you the latest released version of XWiki - - The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle - - The `8.4.4` tag will get you exactly XWiki 8.4.4. - - etc. -- Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. -- Run `docker-compose up` -- Start a browser and point it to `http://localhost:8080` - -Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the values you need in there. It's also possible to override them on the command line with `docker-compose run -e "XWIKI_VERSION=8.4.4"`. - -Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it you can issue `docker-compose up --build`. You can also build the image with `docker build . -t xwiki-mysql-tomcat:latest` for example. - ## Pulling existing image -This is a bit more complex since you need to have 2 docker containers running: one for XWiki and one for the database. +You need to run 2 containers: +- One for the XWiki image +- One for the database image to which XWiki connects to -Here's a minimal Docker Compose file using MySQL that you could use as an example (full example [here](https://github.com/xwiki-contrib/xwiki-mysql-tomcat/blob/master/docker-compose-using.yml)): +The simplest is to use the Docker Compose file we provide. Run the following steps: +- `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/xwiki-mysql-tomcat/docker-compose-using.yml` + - If you're not using the `latest` tag then use the corresponding GitHub branch/tag. For example for the `8.x` branch: `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/8.x/xwiki-mysql-tomcat/docker-compose-using.yml` +- You can edit the compose file retrieved to change the default username/password and other environment variables. +- `docker-compose up` + +For reference here's a minimal Docker Compose file using MySQL that you could use as an example (full example +[here](https://github.com/xwiki-contrib/docker-xwiki/blob/master/xwiki-mysql-tomcat/docker-compose-using.yml)): ```yaml version: '2' @@ -69,6 +69,31 @@ volumes: xwiki-data: {} ``` +## Building + +This allows you to rebuild the XWiki docker image locally. Here are the steps: + +- Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from the GitHub UI. Then choose the branch or tag that you wish to use: + - The `master`branch will get you the latest released version of XWiki + - The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle + - The `8.4.4` tag will get you exactly XWiki 8.4.4. + - etc. +- Go the directory corresponding to the configuration you wish to build, for example: `cd xwiki-mysql-tomcat`. +- Run `docker-compose up` +- Start a browser and point it to `http://localhost:8080` + +Note that if you want to set a custom version of XWiki you can checkout `master` and edit the `env` file and set the values you need in there. It's also possible to override them on the command line with `docker-compose run -e "XWIKI_VERSION=8.4.4"`. + +Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it you can issue `docker-compose up --build`. You can also build the image with `docker build . -t xwiki-mysql-tomcat:latest` for example. + +## Building + +This is the simplest solution and the one recommended. Here are the steps: + +- Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from the GitHub UI. Then choose the branch or tag that you wish to use: + - The `master`branch will get you the latest released version of XWiki + - The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle + # Details for xwiki-mysql-tomcat ## Configuration Options From 92dde643f077004020996a86ccee6f06bfeee108 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Wed, 8 Feb 2017 11:53:12 +0100 Subject: [PATCH 08/12] Typo --- xwiki/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xwiki/content.md b/xwiki/content.md index e436c8c47..c359cf2ed 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -10,7 +10,7 @@ As an application wiki, XWiki allows for the storing of structured data and the # Introduction -The goal is to provide a production-ready XWiki system running in Docker. This why: +The goal is to provide a production-ready XWiki system running in Docker. This is why: - The OS is based on Debian and not on some smaller-footprint distribution like Alpine - Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. From 85703573563515ef0d8467f83c5cd6683f27ab4a Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Wed, 8 Feb 2017 11:54:19 +0100 Subject: [PATCH 09/12] Leftover --- xwiki/content.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index c359cf2ed..6ec6b8c31 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -86,14 +86,6 @@ Note that if you want to set a custom version of XWiki you can checkout `master` Note that `docker-compose up` will automatically build the XWiki image on the first run. If you need to rebuild it you can issue `docker-compose up --build`. You can also build the image with `docker build . -t xwiki-mysql-tomcat:latest` for example. -## Building - -This is the simplest solution and the one recommended. Here are the steps: - -- Install Git and run `git clone https://github.com/xwiki-contrib/docker-xwiki.git` or download the sources from the GitHub UI. Then choose the branch or tag that you wish to use: - - The `master`branch will get you the latest released version of XWiki - - The `8.x` branch will get you the latest released version of XWiki for the 8.x cycle - # Details for xwiki-mysql-tomcat ## Configuration Options From c5d2464ef621562120f62132378962890eff6aa2 Mon Sep 17 00:00:00 2001 From: Vincent Massol Date: Wed, 8 Feb 2017 11:56:49 +0100 Subject: [PATCH 10/12] Fix tabs which were lost during copy paste --- xwiki/content.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index 6ec6b8c31..7498ebf5d 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -11,8 +11,8 @@ As an application wiki, XWiki allows for the storing of structured data and the # Introduction The goal is to provide a production-ready XWiki system running in Docker. This is why: -- The OS is based on Debian and not on some smaller-footprint distribution like Alpine -- Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. +- The OS is based on Debian and not on some smaller-footprint distribution like Alpine +- Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. # How to use this image @@ -28,14 +28,14 @@ Then there are several options: ## Pulling existing image You need to run 2 containers: -- One for the XWiki image -- One for the database image to which XWiki connects to +- One for the XWiki image +- One for the database image to which XWiki connects to The simplest is to use the Docker Compose file we provide. Run the following steps: -- `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/xwiki-mysql-tomcat/docker-compose-using.yml` - - If you're not using the `latest` tag then use the corresponding GitHub branch/tag. For example for the `8.x` branch: `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/8.x/xwiki-mysql-tomcat/docker-compose-using.yml` -- You can edit the compose file retrieved to change the default username/password and other environment variables. -- `docker-compose up` +- `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/xwiki-mysql-tomcat/docker-compose-using.yml` + - If you're not using the `latest` tag then use the corresponding GitHub branch/tag. For example for the `8.x` branch: `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/8.x/xwiki-mysql-tomcat/docker-compose-using.yml` +- You can edit the compose file retrieved to change the default username/password and other environment variables. +- `docker-compose up` For reference here's a minimal Docker Compose file using MySQL that you could use as an example (full example [here](https://github.com/xwiki-contrib/docker-xwiki/blob/master/xwiki-mysql-tomcat/docker-compose-using.yml)): From 1ed00c21fd8b9bf0b1768d2c0088c2f8b4038b3b Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Wed, 8 Feb 2017 14:22:12 -0800 Subject: [PATCH 11/12] xwiki, adjust white-space for markdownfmt --- xwiki/content.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index 7498ebf5d..34d174411 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -11,8 +11,9 @@ As an application wiki, XWiki allows for the storing of structured data and the # Introduction The goal is to provide a production-ready XWiki system running in Docker. This is why: + - The OS is based on Debian and not on some smaller-footprint distribution like Alpine -- Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. +- Several containers are used with Docker Compose: one for the DB and another for XWiki + Servlet container. This allows the ability to run them on different machines for example. # How to use this image @@ -28,17 +29,18 @@ Then there are several options: ## Pulling existing image You need to run 2 containers: + - One for the XWiki image - One for the database image to which XWiki connects to The simplest is to use the Docker Compose file we provide. Run the following steps: + - `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/master/xwiki-mysql-tomcat/docker-compose-using.yml` - If you're not using the `latest` tag then use the corresponding GitHub branch/tag. For example for the `8.x` branch: `wget https://raw.githubusercontent.com/xwiki-contrib/docker-xwiki/8.x/xwiki-mysql-tomcat/docker-compose-using.yml` - You can edit the compose file retrieved to change the default username/password and other environment variables. - `docker-compose up` -For reference here's a minimal Docker Compose file using MySQL that you could use as an example (full example -[here](https://github.com/xwiki-contrib/docker-xwiki/blob/master/xwiki-mysql-tomcat/docker-compose-using.yml)): +For reference here's a minimal Docker Compose file using MySQL that you could use as an example (full example [here](https://github.com/xwiki-contrib/docker-xwiki/blob/master/xwiki-mysql-tomcat/docker-compose-using.yml)): ```yaml version: '2' From b2ba6c613156ec7127ead98b16e2055dd89104f8 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Wed, 8 Feb 2017 15:22:40 -0800 Subject: [PATCH 12/12] Tweak a few minor references (point to the logo included here, remove microbadger badges, update image references in docker-compose example) --- xwiki/content.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/xwiki/content.md b/xwiki/content.md index 34d174411..3ef5173ba 100644 --- a/xwiki/content.md +++ b/xwiki/content.md @@ -6,7 +6,7 @@ As an application wiki, XWiki allows for the storing of structured data and the [XWiki.org's extension wiki](http://extensions.xwiki.org) is home to XWiki extensions ranging from [code snippets](http://snippets.xwiki.org) which can be pasted into wiki pages to loadable core modules. Many of XWiki Enterprise's features are provided by extensions which are bundled with it. -![logo](http://www.xwiki.org/xwiki/bin/view/Main/Logo?xpage=plain&act=svg&finput=logo-xwikiorange.svg&foutput=logo-xwikiorange.png&width=200) +%%LOGO%% # Introduction @@ -17,8 +17,6 @@ The goal is to provide a production-ready XWiki system running in Docker. This i # How to use this image -[![](https://images.microbadger.com/badges/version/xwiki/xwiki-mysql-tomcat.svg)](https://microbadger.com/images/xwiki/xwiki-mysql-tomcat) [![](https://images.microbadger.com/badges/image/xwiki/xwiki-mysql-tomcat.svg)](https://microbadger.com/images/xwiki/xwiki-mysql-tomcat) - You should first install [Docker](https://www.docker.com/) on your machine. Then there are several options: @@ -46,7 +44,7 @@ For reference here's a minimal Docker Compose file using MySQL that you could us version: '2' services: web: - image: "xwiki/xwiki-mysql-tomcat:latest" + image: "xwiki:mysql-tomcat" depends_on: - db ports: @@ -57,7 +55,7 @@ services: - MYSQL_USER=xwiki - MYSQL_PASSWORD=xwiki db: - image: "mysql:5" + image: "mysql:5.7" volumes: - ./mysql/xwiki.cnf:/etc/mysql/conf.d/xwiki.cnf - mysql-data:/var/lib/mysql