From 969091c4c590befe236a71d4a7bce5823fff020d Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Thu, 23 Jul 2015 16:31:56 -0700 Subject: [PATCH] Add redmine docs --- redmine/README-short.txt | 1 + redmine/content.md | 81 +++++++++++++++++++++++++++++++++++++++ redmine/license.md | 1 + redmine/logo.png | Bin 0 -> 8827 bytes 4 files changed, 83 insertions(+) create mode 100644 redmine/README-short.txt create mode 100644 redmine/content.md create mode 100644 redmine/license.md create mode 100644 redmine/logo.png diff --git a/redmine/README-short.txt b/redmine/README-short.txt new file mode 100644 index 000000000..853e40976 --- /dev/null +++ b/redmine/README-short.txt @@ -0,0 +1 @@ +Redmine is a flexible project management web application written using Ruby on Rails framework diff --git a/redmine/content.md b/redmine/content.md new file mode 100644 index 000000000..29190ccce --- /dev/null +++ b/redmine/content.md @@ -0,0 +1,81 @@ +# What is Redmine? + +Redmine is a free and open source, web-based project management and issue tracking tool. It allows users to manage multiple projects and associated subprojects. It features per project wikis and forums, time tracking, and flexible role based access control. It includes a calendar and Gantt charts to aid visual representation of projects and their deadlines. Redmine integrates with various version control systems and includes a repository browser and diff viewer. + +> [wikipedia.org/wiki/Redmine](https://en.wikipedia.org/wiki/Redmine) + +%%LOGO%% + +# How to use this image + +## Run Redmine with SQLite3 + +This is the simplest setup; just run redmine. + + docker run -d --name some-redmine redmine + +> not for multi-user production use ([redmine wiki](http://www.redmine.org/projects/redmine/wiki/RedmineInstall#Supported-database-back-ends)) + +## Run Redmine with a Database Container + +Running Redmine with a database server is the recommened way. + +1. start a database container + + - PostgreSQL + + docker run -d --name some-postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=redmine postgres + + - MySQL (replace `--link some-postgres:postgres` with `--link some-mysql:mysql` when running redmine) + + docker run -d --name some-mysql -e MYSQL_ROOT_PASSWORD=secret -e MYSQL_DATABASE=redmine mysql + +2. start redmine + + docker run -d --name some-%%REPO%% --link some-postgres:postgres %%REPO%% + +## Alternative Web Server + +The other tags in this repository, like those with `passenger`, use the same environment and `--links` as the default tags that use WEBrick (`rails s`) but instead give you the option of a different web and application server. `passenger` uses [Phusion Passenger](https://www.phusionpassenger.com/). [`tini`](https://github.com/krallin/tini) is used for reaping [zombies](https://en.wikipedia.org/wiki/Zombie_process). + +## Accessing the Application + +Currently, the default user and password from upstream is admin/admin ([logging into the application](https://www.redmine.org/projects/redmine/wiki/RedmineInstall#Step-10-Logging-into-the-application)). + +## Where to Store Data + +Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the `%%REPO%%` images to familiarize themselves with the options available, including: + +- Let Docker manage the storage of your files [by writing the files to disk on the host system using its own internal volume management](https://docs.docker.com/userguide/dockervolumes/#adding-a-data-volume). This is the default and is easy and fairly transparent to the user. The downside is that the files may be hard to locate for tools and applications that run directly on the host system, i.e. outside containers. +- Create a data directory on the host system (outside the container) and [mount this to a directory visible from inside the container](https://docs.docker.com/userguide/dockervolumes/#mount-a-host-directory-as-a-data-volume). This places the database files in a known location on the host system, and makes it easy for tools and applications on the host system to access the files. The downside is that the user needs to make sure that the directory exists, and that e.g. directory permissions and other security mechanisms on the host system are set up correctly. + +The Docker documentation is a good starting point for understanding the different storage options and variations, and there are multiple blogs and forum postings that discuss and give advice in this area. We will simply show the basic procedure here for the latter option above: + +1. Create a data directory on a suitable volume on your host system, e.g. `/my/own/datadir`. +2. Start your `%%REPO%%` container like this: + + docker run -d --name some-%%REPO%% -v /my/own/datadir:/usr/src/redmine/files --link some-postgres:postgres %%REPO%% + +The `-v /my/own/datadir:/usr/src/redmine/files` part of the command mounts the `/my/own/datadir` directory from the underlying host system as `/usr/src/redmine/files` inside the container, where Redmine will store uploaded files. + +Note that users on host systems with SELinux enabled may see issues with this. The current workaround is to assign the relevant SELinux policy type to the new data directory so that the container will be allowed to access it: + + chcon -Rt svirt_sandbox_file_t /my/own/datadir + +## Port Mapping + +If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used. Just add `-p 3000:3000` to the `docker run` arguments and then access either `http://localhost:3000` or `http://host-ip:3000` in a browser. + +## Environment Variables + +When you start the `%%REPO%%` image, you can adjust the configuration of the instance by passing one or more environment variables on the `docker run` command line. + +### `REDMINE_NO_DB_MIGRATE` + +This variable allows you to control if `rake db:migrate` is run on container start. Just set the variable to a non-empty string like `1` or `true` and the migrate script will not automatically run on container start. + +`db:migrate` will also not run if you start your image with something other than the default `CMD`, like `bash`. See the current `docker-entrypoint.sh` in your image for details. + +### `REDMINE_SECRET_KEY_BASE` + +This variable is used to create an initial `config/secrets.yml` and set the `secret_key_base` value, which is "used by Rails to encode cookies storing session data thus preventing their tampering. Generating a new secret token invalidates all existing sessions after restart" ([session store](https://www.redmine.org/projects/redmine/wiki/RedmineInstall#Step-5-Session-store-secret-generation)). If you do not set this variable or provide a `secrets.yml` one will be generated using `rake generate_secret_token`. diff --git a/redmine/license.md b/redmine/license.md new file mode 100644 index 000000000..f20219ffe --- /dev/null +++ b/redmine/license.md @@ -0,0 +1 @@ +[Redmine](https://www.redmine.org/projects/redmine/wiki) is open source and released under the terms of the [GNU General Public License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) (GPL). diff --git a/redmine/logo.png b/redmine/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..bdfabb1ca8e51b7c914b198e19a99c12c67981af GIT binary patch literal 8827 zcmeHt_di?z`!`C5S({p=HEPw~rL{LjY+_ThC05M7)#^}c&s5C_qBb#0TYC$l;Y|^H z?-AeQ^Zon*_Ye1P_kA9ZBt*%0s;yxO;sZT0wQzZyyxz1 z;9UX+s|P-a{gky#?gB^XU8gwU`rd0z3qJw^(%qXEp>nxI2Jj^lM9mzc;_GY=dFA8% z(BzeuGl7_tu!y*@n24x|VF24Du!i+!jj@jlB+%a1nc#(!kAw3=^;f>mfj+(-eh*cQ zC2m)beS_N67j zyxjnVIw>aRHtK?qfWVLj8WQ51h0O(i;FBa41U|a%-Y71Hx(awFe`E(NVp8uQA|Md? z7)b)$%|u8>K+qvV#6Un0Y5)K54aKuqLb}TMVaopQB*Q*0en#OTV;?|??8JhqpEhT> z3wGN4&aXoPUbTB;%K72ejpi=G)`B1%WYT*w58r7W0CV&Iu}O1&e&=?02hU%Qo#gx} zaB9y6vJXz%rH;vY^CnjYX{9wyM37Q6H)l&^D$6ocqeD4&U650!=W?H1OwB{nLyy*8oNY>f?o~T^_IUEzH+}Sq zF)JN0+;=KTub?ot%1wn(R+`#Pgh)doX5>*UBIo%X@LQ}S7+bZu+^<= zR>pG%&RYub@}u{0almSR9JB~(@z53Lw~Oa+hL~-)eDV_e`=#G^EZvFnauw`+nS6zr z1>^fDE4CCP!jnVsu_fc)fq1XL!b|B#%O=rOKGwx`*c`Azex0>mC9b7d z%x}Q~e)W^KeiM~LU8OzX_S#3Hg%5oBrbbu(_mk`02sCf#jf#Ai0zb2$K8S#h)|d7; z&sGz%9nVkJoGHdS0)cg}ntCfLYNC3&K*R{d56Ta0Z4sBEW=*XM%eItZ-3 zP?n);8zH$7Nuo=y@{W7y!_eUVg3zaXvDk!X?OJWCe{v4%a1U~xrmjnmcKUlbA0l@Q z&hfiL>}R_x8_p7qQ|3zA*lt5rN}siqIZ36&3Z0fQRI!En?Tf8#)6oaa3J*E1w%^P& zFF9BZFYnI!toTQ$AltL1u9nAF^K8Vvyg0fq5+4cTqP)6*GKcQYrOc8m1|i9>m$%+2 z$v3Q-W=bL4`>sm&pBh-UKClk-flP}fAr+tTabVy0jVW?9#plP7*D48ErCSSfT>7?R zu}`44wubxaBMpwP161Ztp1pbe7=V5MEPkJDb>C~X&TMm=sE>{iK}=qWGP{w{V-_E> zt!vJmC57nIr0>TN=aUXFkRIj0f9xO zdgN+O!_9SoxUxGJ`0BsWEt{^Ff5TpJ#DX?s@U?0@it?U;(uOg2&DFeLV_Pjd)nsKu ztmfe|{fZhfbGpKCFJIe=xckvSeeGid{Ou7kY|jz8(N=&9IuS1cx{ zGSgY|PmPU!E|Zk+f!2@Xe!`SYX^br$w z^49dPhx66=DDqRC^VpxsLEoQY8^+!RL%6rc^%-?PAuSirJ^Dyq>b(S|TSxyBI(WcO zN2{SMc6pp_RCo9Qh5C}Vtz60HNlwj>nfyEUqmr$Qn^pSgaohRfSMr@rQOrubZOs;a zHfg$*yQx$!h{`AN`s}4S1O8GJ{<^sq9046HPhdT+YAiiii>OqoygCqmGYBrc!Z`Z0 zasu4qD*YIm%ETyI@$NI^RF+{gXWy_k&zU*x=ret+B{YQRTR<-8VVJL#>vfoa;LcyD zj>78sFEziV_mvGl{kM+PG4eiuP-{GR``WULg*AR{9!`(zYN+c zJC=Ua1>zGT`FjEVoo3Z-O_|9gzvJ@n zreDq?b~j}Lzd2gY5#a~KE%?<;fw6l*3f%51OEp(WV9i(v4ZU!K;Lc_m5S}b&HIBE1 zG5lyCDLG3kxE(dEWWDV$0qi+_6XfS844hdNO&Y~slIUoFVAWd%{@zSHenPvwMM@LM zV%6g+VN)@HnuMq4_#FN@3SVz*4}B8tTVeY|B?4oV)>Y7>L}Z%eXA=^pt`fuFxKzWH zvZe^)>(?L?NjExDG%Ll*5o=B@6R0Kg3R_hre~YUyek^#eL*>kXVon>o;q7 zsa_^2@J~`J>cEtq+~AG5$6`&F7```LrS*v?J!8WUYJX0e;)%v1|%Z|QuFY3?XSc?!s=7MHup>p6 zJvtc~>}AY0Cs48uYSsvSVqa$7!%1ZNR-2La7ZpVho?|{$%8h$CHwAz_@51n6 z)MW49UJf$9#i+o{58OY_O=Z7^{Edv47x&MTmiccwfO0I;Rpm@oOvsgVJ)5-%qLWqW z;C~*$LfTI~nEw>}6+|v}&(yRTSC+CiL^763PLqicS#DY0`AjF06c@T0Mdw*DW`^-WM#Y7y)6up9Rw{aEBd<#ez%1)p-b?ZyO@&(36|cL- zpEP93(0l=+drDc+l+#4Lz6in+`st&d{oU%s963=zdPa2I!K`%82&}#kd)%MExOB<- zOiGZ2W3EwfV`>N}Lfs?w-gVABv@)q89WWebxyS40+P6HFtz>j}2!-b;`J>*X9{`Jc zw_Gs4{;a#HIv_6qbo-oM(D-0pKaVMmnQ^KJD?HAR?#Z*U?1~!NFztgc{AI4QSg|v+SUSYwf1t9L_`l{i2L+yu?E9ih|nmi+P(#$T+HlL-KtW}{o@hlb9sLUnF9Va z{fFcC0)DPr4>p+>bCglsuOf|ulj@3skSXig#d9~V*6&b#0puEhK|uOvl~-9aW=OlB zs=FrE<^__vrB+_d;TL)p_x@xKt?}~!h5Tr*Z1F1x`DaRV0{_z7#B zvV%j0Vc{vx!HewF>Dov7v2}|WP&b6`_8(RI$D7?G>QXF%9i3egEe=V4C88IYVaO}9 zX433pZOsc9(e0?hd`;hOidmloLS04L9e)zoA5S%x>no4D`V2Q-s?LC5e7G%3(g!@{G_@3409W9G7@gR$opu@^ZV7KTUYg) zQ$@0(@-{(o{tk_sv3KaP(HgP%+GuVTJ90wAb3mWNJtMZFlvMmUeNomSKq}$JWiZ82 zvB*bq_C!Y?=XRr34?I`XV%yP*+`F7?DTKC1=P-ou!$PMy#_xNnL+5=U3S?|Ubg;<0 zFFxC{Ty-8C1MXudkP;Lhu$@`j^@#kHK;d?hUbWM2#msTbJP&(rqXmdo7p<4kg6}Mr z-bs`9u#kmk!t$c8y=5u(PO4wF_ar6(b=Q%AntsE;t1!crT1CDaM`fM4%sH+( z&QZf>kO6?u4Q#G6%SX1IUHEqDHGHUvLtpl#1C=+`dm0920$@-aDOb63=|Q7etC4fBLW5Cmu{>Xl%-`(^>t%@G+dNDz^rc?fDCVnMRW zy&qf~gV*MCGqDW@^}!4Rn~MUrqHd&tUrZWvzZob7p@;f|8~N`vlf|tpZtG(0e>hDt zV4Yd}p4i2&8UzdD;R{mzmSFeH1^@o?BXfm{0161_H~_mq0egunqUiEUxm`(J{Ozg7Yb z=HW_%b7O`;;$1>S9AHm_8%^C10f~jOJl=9$<^fN?dXGRwC2LGXr z&ox*oi%`Mg@rYhjQ8|358zT55Aadt+1t3d0UK;i zmu)JnCnO9**1S^vk2z3o0(}zy7St5zt@tMc=eu^l^5FahmJe{!y#O;zmH+XID1;<_^-QF?MRyN45LfIu?*Gv1blzIZInTAphXx zL@aa042SeI_8e}0+54PuOfb4xe3up5v6?s8a`(yk)y8o8}cTN{5isz zS0`1VRzbu41D}MgRYlrTG3!wU#TJGSK*0;R32n8f#4gMWC{7-A$hZ3y9Aoq>J;3y5 z(BR_6Hotk8eF!(j~U8ad?wBB1d_4AAlGaTZZW(0^xKs5b=+yU zM%Lwe;J>wi68)8vhA?L2RKNIR@7Q!H5(~1>Z`?Pn%q*A5B>f)nMrhZWzFJ!pf>Ys9 z8TGqvl5NQSK5~ypE_t>oMA-CawB+LDF-1V&E$;V`&dKqbGFz7dHbpX2{Sz4FqWcoo zWT9hK--QaM0Bi8YI}Vq`Ynnr+Bs{#V79hPX3Y0&G8kfZ2jUD340j1Nr#TWP89vTx1 zW@ogVrY`njE6-d^i-sW%q4{MNGmj})V54*44t&ZzeH}plnKdJ+jaY+Q%%q&O2O6_s z5RDy=#D$v%41KhJf7B69&Lm@;#Zsg^BudkJAGTVSk)qv`fojf7OudzKaxT{FSo34; zi@>%OY*wH9Ut9nF6x-oHh$RRI5rxw~k6e&xa{4-NZuPT~{DoX4 ziK1gy2rqfwhVs`HM|j=n*h@~2VAqDxGw4$@m~*+1^YNqr(5sxJV3^!|bV6=v)x(6Q zF4gKykaU0t)L616FLWN>Opj=woAxLaCl?n`sSE^V18wP@)Mf?1ExISfh>QA`F4K%! ztZM8Xvw`+rbR)m$3nCE|r;m(qS-DMv07CnNJU8(0fn;1ZEP4_|hgmj(=?KRzicKwiYC2?Uh%+YxYd^Jk(X59VEi- zzAp#)h}}8Ibd^n=cD!fW_&Z!hQ~)zQ$)MjCryvv;u1vle;!R|a`Ff96hykNGEcSW) zL%W$s`MU>56GRLEP4v)sI0dH;IC`8L?+O;qc+Ks5&J4}`%3t6EpgV8!uH#*EsegZ@ zMHGb&30QmYDNQAfy6*sGyN(njYY_;VH`!|W?NDZq1hI%h1~bn;U35fg6pdBO;KuIZ zV5!d&FC2i8+Qjuv>=I^MaTaIIUBHqB%oqoD?P7vLDRnvR@&!|TNpt|D$6q&50t13t z>jTE#A221JsrGT74I^?n$SsCp_JIWPE_?Hb)M>A(-mYnQnxy@!Tu?mx@`<88U(!rJ z(OA_U^Now4P)55qV>)0I_p`2pm$AZ=zwBsfLS*6f@Nvqls6s~Wf2%dIX4iBercuj# z;D&O+(h?HWSSnyv{AFZzw*NjSaQ5o|^3>R~8Oufx`C3LWEG%qne*P&JSAUvNvPvvv ze4OUP`y$O$lP(bv?T05PA7-~0V8iK${#Y!Qi)-=Vta~efWlg8Do8u9|#r-ORX?IUg z-Mr9!EoK&$58=qRHpK^?y0-;AvahbL#;{l+TcnwQU2yB%x4Y)W!z_`TH@EQ9k*alp z9^Su?oDu+s9i{GFHDb5FP_Z@1{c3A#b8{|lYMKeU5aFdG)iN_nkK47K`4ma=)$a5v z{EZCjXufjtUGo{T*e=;%1G~BDX{H^}+lO|9ReE4B?C|hVwcXpthmkr7QQ7Q1R^Mr7 z2!%qO03Ma|6N41k-=MIICl^2e?x}(|0#HS8_!A63B149i@*XjfRz%It_IAQh?>@A3 z@d%oHJJpcyF(CISS?26k!q8uBsflScnun_-R#7EC@trc~z1XhBy`b)$6ODG{IqnF` z%|x!vNB8CY9Qw-LohG)6daFe44xj;6%GlG;HZ8AGN0Z5t*D|cw5>f~D&%99YNvXZ9 zgioK;5N2pc>ZEtS%a2Qr3ldb=5VKop+uPpvqLmk4%XI(U({yw!kYP>8I8j#pwiA2A zR1vm&aWytI#hY)asj8~LZZPoX=~QS3g&4wVvo#FkKIEDCQ%+Vj9PJo4 zpO7}Gbr9LH_vH49<)%$Bp zo4CIhvuHGfI9Qj2@hI!G&FZs2__aHjpPU;b3@FLW%uFKVvAZ;Is-x3i=(xGDk(`i_ zkTGRGY~|sBc&D7Ng+pU1=XcUy%P6e5a+O5cDfkPQtF)sX{ZUxaEqK+;pFgY=%v@ZQ zu_`ULKDD`aB7B2`gEv;oGdK!1`dviyc^%=dlj{daxV5z<3VX4EQ(w|msy zN#cfCA>aVa@|cyfKZb(k8zUGrXh?t0U$h1v0Q)$<^EsxfzP^4{O-j*@B&u^&t*WR< z4Y1Im%VM!EgOd6N;2mx=tB z2~2_gvxKB%Jm4YW>gD;O_#N8K7ac@~yAwZu|K01pjHzrh?TY;L>C@?68?!s9B44H{&W!c&$upf_(jzn<} zC&Mee0HCd^f!U(!e8St6R&reBOEjX%Jx&2{5WV zeV)S$+-l}-ZqRCg_FDns7vLNM>FCI!p z%;GT(ltN|0z+e}wYxk6hA@UnF`E5tx&^?n=L&oQlF#gn27%$4r627ihEM~LPxpAb9 zxZhhwUDm$GskbyhG6iM)D!jp3>nZ$4PQ|Ef=lz4q+S`+-Ugbu)1|HE*CKbikkaaYS z*I^q?W(&NTCRgY)>moT`K2{*kt38@gwejyXN~KbxP%3H;Dke4REzO4qtqF&&@mm`w zt$wTg;Zk;xCa3@}Gyf*?m1hQV4_#c!sR(K{PVLm~%C8ej5~nXR@q*u5gBL>QYtC4m z$HMD19*g|as{Z&ms64QM8!_zA?7hAt=lbQsw>!&tH8NUpCQG8*|?U?)3=e$)J3P?<1 zFzEO)a034R?E_(xgW?G_ke;b2XMRZu@3PO1f#TUxp*$5W$lHWv;k7wtcGfZNR#i-` z)5QJctfflYmGTS9*sjqq_b*7pbn52l+?ECf_{ahgIP~NOOv$kj;yB&3t3)$G%MhTEujs+|B}DP0A!xEU)l=Okl6bBiAVA{|xN}T=ig+S^BXx=}rAQ>qBvZ?Ot~|MN zQuX}Q(J0I~!gSVrR=QWN(+2d2jq-P45u4a6ooL=k)63VkKr#Sau{&q#G@Gbgn&q+F z$+~{8=j7Cs4v@_yx-I54{10M;{SQj@Hbp%FeV(RrAxU-8F;1oc@HC1b|dll9Hn`k?3Kfio5euJy_nb?qh~ za>*CZ?%!3N5;xjl;FfdQXrsv$*tq2LPtVodgxaIE_Iii1LCszhZIgzj7@oYN7E7>C ztN0K!(7O6$u9-vf55hKk^_dm~55ZI)TTsxJ6-lc;Za#b~cY7lM&DrGyv)H%~`F4=B zRr)lUfPnDl&3^%UaoQ)1ll5zJ0!#WnK2L#1>Ar&xs(g(o;< zH;F2M;~lM2c|$`wr!oN_2|C!A{LY$j*Jt-m{iN=>5V&qvTKQu3L_NSq9Njy1yoD_|6%|C=|3FC)l`9p i>s#A*2ne3{o?fGriHya0=+*%Z5@@OEt5z!8{qsMA_`rw& literal 0 HcmV?d00001