From cdfa39c420e8c87a88eb5b032662e01a20653cf7 Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Thu, 16 Oct 2014 15:51:50 -0600 Subject: [PATCH] Add crate +logo, allow custom user-feedback section --- README-template.md | 20 +--------- crate/README-short.txt | 1 + crate/README.md | 88 +++++++++++++++++++++++++++++++++++++++++ crate/content.md | 50 +++++++++++++++++++++++ crate/license.md | 3 ++ crate/logo.png | Bin 0 -> 2161 bytes crate/user-feedback.md | 19 +++++++++ update.sh | 6 +++ user-feedback.md | 19 +++++++++ 9 files changed, 187 insertions(+), 19 deletions(-) create mode 100644 crate/README-short.txt create mode 100644 crate/README.md create mode 100644 crate/content.md create mode 100644 crate/license.md create mode 100644 crate/logo.png create mode 100644 crate/user-feedback.md create mode 100644 user-feedback.md diff --git a/README-template.md b/README-template.md index df32e012f..5fee3f5d0 100644 --- a/README-template.md +++ b/README-template.md @@ -12,22 +12,4 @@ repo](https://github.com/docker-library/official-images). # User Feedback -## Issues - -If you have any problems with or questions about this image, please contact us -%%MAILING_LIST%% through a [GitHub issue](%%GITHUB_REPO%%/issues). - -You can also reach many of the official image maintainers via the -`#docker-library` IRC channel on [Freenode](https://freenode.net). - -## Contributing - -You are invited to contribute new features, fixes, or updates, large or small; -we are always thrilled to receive pull requests, and do our best to process them -as fast as we can. - -Before you start to code, we recommend discussing your plans %%MAILING_LIST%% -through a [GitHub issue](%%GITHUB_REPO%%/issues), especially for more ambitious -contributions. This gives other contributors a chance to point you in the right -direction, give you feedback on your design, and help you find out if someone -else is working on the same thing. +%%USER_FEEDBACK%% diff --git a/crate/README-short.txt b/crate/README-short.txt new file mode 100644 index 000000000..2655e246a --- /dev/null +++ b/crate/README-short.txt @@ -0,0 +1 @@ +Crate is a shared nothing, fully searchable, document oriented cluster datastore diff --git a/crate/README.md b/crate/README.md new file mode 100644 index 000000000..e447c91fc --- /dev/null +++ b/crate/README.md @@ -0,0 +1,88 @@ +# Supported tags and respective `Dockerfile` links + +- [`latest`, `0.44`, `0.44.6` (*Dockerfile*)](https://github.com/crate/docker-crate/blob/0.44.6/Dockerfile) + +For more information about this image and its history, please see the [relevant +manifest file +(`library/crate`)](https://github.com/docker-library/official-images/blob/master/library/crate) +in the [`docker-library/official-images` GitHub +repo](https://github.com/docker-library/official-images). + +# What is Crate? + +Crate is an Elastic SQL Data Store. Distributed by design, Crate makes +centralized database servers obsolete. Realtime non-blocking SQL engine with +full blown search. Highly available, massively scalable yet simple to use. + +>[Crate](https:/crate.io/) + +![logo](https://raw.githubusercontent.com/docker-library/docs/master/crate/logo.png) + +## How to use this image + + docker run -d -p 4200:4200 -p 4300:4300 crate:latest + +### Attach persistent data directory + + docker run -d -p 4200:4200 -p 4300:4300 -v :/data crate + +### Use custom Crate configuration + + docker run -d -p 4200:4200 -p 4300:4300 crate -Des.config=/path/to/crate.yml + +Any configuration settings may be specified upon startup using the `-D` option +prefix. For example, configuring the cluster name by using system properties +will work this way: + + docker run -d -p 4200:4200 -p 4300:4300 crate crate -Des.cluster.name=cluster + +For further configuration options please refer to the +[Configuration](https://crate.io/docs/stable/configuration.html) section of the +online documentation. + +### Environment + +To set environment variables for Crate Data you need to use the `--env` option +when starting the docker image. + +For example, setting the heap size: + + docker run -d -p 4200:4200 -p 4300:4300 --env CRATE_HEAP_SIZE=32g crate + +## Multicast + +Crate uses multicast for node discovery by default. However, Docker does only +support multicast on the same host. This means that nodes that are started on +the same host will discover each other automatically, but nodes that are started +on different hosts need unicast enabled. + +You can enable unicast in your custom `crate.yml`. See also: [Using Crate Data +in a Multi Node Setup](https://crate.io/blog/using-crate-in-multinode-setup/). + +# License + +View [license +information](https://github.com/crate/crate/blob/master/LICENSE.txt) for the +software contained in this image. + +# User Feedback + +## Issues + +If you have any problems with, or questions about this image, please contact us +through a [GitHub issue](https://github.com/crate/docker-crate/issues). + +If you have any questions or suggestions we would be very happy to help you. So, +feel free to swing by our IRC channel `#crate` on +[Freenode](http://freenode.net). + +For further information and official contact please visit +[https://crate.io](https://crate.io). + +## Contributing + +You are very welcome to contribute features or fixes! Before we can accept any +pull requests to Crate Data we need you to agree to our +[CLA](https://crate.io/community/contribute/). For further information please +refer to +[CONTRIBUTING.rst](https://github.com/crate/crate/blob/master/CONTRIBUTING.rst). diff --git a/crate/content.md b/crate/content.md new file mode 100644 index 000000000..cd3b8ba80 --- /dev/null +++ b/crate/content.md @@ -0,0 +1,50 @@ +# What is Crate? + +Crate is an Elastic SQL Data Store. Distributed by design, Crate makes +centralized database servers obsolete. Realtime non-blocking SQL engine with +full blown search. Highly available, massively scalable yet simple to use. + +>[Crate](https:/crate.io/) + +%%LOGO%% + +## How to use this image + + docker run -d -p 4200:4200 -p 4300:4300 crate:latest + +### Attach persistent data directory + + docker run -d -p 4200:4200 -p 4300:4300 -v :/data crate + +### Use custom Crate configuration + + docker run -d -p 4200:4200 -p 4300:4300 crate -Des.config=/path/to/crate.yml + +Any configuration settings may be specified upon startup using the `-D` option +prefix. For example, configuring the cluster name by using system properties +will work this way: + + docker run -d -p 4200:4200 -p 4300:4300 crate crate -Des.cluster.name=cluster + +For further configuration options please refer to the +[Configuration](https://crate.io/docs/stable/configuration.html) section of the +online documentation. + +### Environment + +To set environment variables for Crate Data you need to use the `--env` option +when starting the docker image. + +For example, setting the heap size: + + docker run -d -p 4200:4200 -p 4300:4300 --env CRATE_HEAP_SIZE=32g crate + +## Multicast + +Crate uses multicast for node discovery by default. However, Docker does only +support multicast on the same host. This means that nodes that are started on +the same host will discover each other automatically, but nodes that are started +on different hosts need unicast enabled. + +You can enable unicast in your custom `crate.yml`. See also: [Using Crate Data +in a Multi Node Setup](https://crate.io/blog/using-crate-in-multinode-setup/). diff --git a/crate/license.md b/crate/license.md new file mode 100644 index 000000000..9c7f4d6e1 --- /dev/null +++ b/crate/license.md @@ -0,0 +1,3 @@ +View [license +information](https://github.com/crate/crate/blob/master/LICENSE.txt) for the +software contained in this image. diff --git a/crate/logo.png b/crate/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..63c4ee6e2d403f2ce7bad2fbc917280f8e395cfd GIT binary patch literal 2161 zcmV-%2#)uOP)6 z-sAmlDUU)61xhJ&=iJ_wTY*}n_tKX0H9vZLd+WVD{hagro!{^D^7d|t(Sm7pAyb=p zy$4yxYyJ;8{v!|w_~GHfADQ$kxUGBLefhpZtsF5ad-6W7veb%;5b zajY|KrsVUQ*C*L(L-F~13{sSdLwZq%mD1qpAr#Y48URH=c8+!E97w+#u>{D1Xd6-p zNCjhL)B|Y%R45eIhlPb%1(0YoheIb$$q8(>D^J=Y1|?P?P@)GnYq(HHN5^v1IlRzj zHnJRs6`&EihrmW;X?Y`CNt<381YscqJ_<$zU^9V@hz(CTo3?F?5JAF(kG4_-VK0G= z$kGa=Z7nm4fgsGI!P`Skwn#e>u_T z(l&Mlo3o1x96ELqME-#TUR$tqIsA0w5HvMNS-ntKH+Kk`K4Vz#iCVH83bLNUgTz~) z)pD2QpR-^QOc41&NntK4umw#D9rk;a?Fvw|$gCf>k9X`D6f|nYbN7JHzBmX!A3ba+ zOIVX;&RYaLo&Zu4u5#0$LLqqjil}X0zW`Rwv2pwEVZSFQGaVi!Cs^eCxFhkUAhUZOE3FKxzHae!YsnK?3qgawxW_G28`A}0)1{I~n zkoNCwPC+vzYIv8)j9|mD6c^Hu^d0T(;Og#98Q!*}igI2UJ$E1PWdxg2As=uI8%nxy z8QNM~s7!^Ulapm(8%!s^J!q8^gV7RB4PoVHKZixjR)CMl-{P=Yi;8ly(TqFKe78H& z6Iv^1JU(w!&Wqh>k6MjJechMf7Z5~xpruB((Ui{+0l0^kH%yI)G}_mxRI+|OI1S|N z>I&kTDrl&e=&sSv-)`ZVI5~uR?Cw@k3H}C&*nVMqclCO+kFBq*Vt-T%3Z?_}dPBqe z+A(anQleK~btRnm`b&1*s4b{lrGjSr=K|MyvF zSIAjEmw%8h?J+Frrlx?Rm7AKNKJ9^Br`~kItE0p0V(ICK5^;Un(OgJMAzub$+hqW0xGA*l)gyq<40VnS+Fsy`iqvYFcg`wR&DqQ zghEFudmI`TF{%{=T(&C6$~4+H4uKZEZX-8o7z7#yuCZPW#}4d+13S0C>F>YOxmP=l z+vY7^3L8G%23vRSgYA3wkKB#oYQA1`7A}SpXU-u2bx<+ujW1uR#f^p@-${hY)55{k z-NUeNO2jM(4WEfzY5^xMR8m(%%|@{>c$6Ep(;4aV)%_*1u1*w2#g1@f%X*SdP2=_Q z^zt@T`t_q69{q4_)EZ`<_Y-dnbf;)^8|Uo8N!o*%*pwspj#tXqbFR&zZWIUpap!(B zc}()nDD`(!==0nzn_Mim(JTIJa`bQLX*Q6 z8EJ4Y@up>Fqc1WZL16GCShML9qnHirdHO?0ymHa18X+wy9)d%rQZbueVYB8!d0`$@ z6c@5`&g{$#c=qT4RF#()?axfR&-&-ZlcZmcf5Tb(-o6$`bs%%n9dDHSi2vsTq}@rT zf?etdFR0h5ke_aDlv-Vn>+0-)w3Gx`wQ-AajDcpScp}j~$b!p}D*xs4G2;%E?QL)L zzG3Am@DgBbqaj6W3$>2k_(Lm(Jia6^8$3L{V4SOQ>O&M547C-dB!C(P*-QmNhDOlg z{$S(zqg3(@+tLJqh-l1>Y(zFGyt1~Iz(!Af~$fw zi7{+=ZOmKHe_vF*d?AQo_*Wb*q^X8fJ{^1E5iA`6)=ipZ2-r~L;JekCykp(oEivO6 z;4wiAW1qetd8oD8&6bJ-?;o;#zTWTP+TAfu|TB_B< ng)HOMTdotCmi`tU{|hhx0+sim|5/dev/null || cat 'user-feedback.md')" + license="$(cat "$repo/license.md" 2>/dev/null || true)" if [ "$license" ]; then license=$'\n\n''# License'$'\n\n'"$license" @@ -86,6 +89,9 @@ for repo in "${repos[@]}"; do echo ' LICENSE => '"$repo"'/license.md' replace_field "$repo" 'LICENSE' "$license" + echo ' USER_FEEDBACK => '"$repo"'/user-feedback.md' + replace_field "$repo" 'USER_FEEDBACK' "$userFeedback" + echo ' MAILING_LIST => "'"$mailingList"'"' replace_field "$repo" 'MAILING_LIST' "$mailingList" '\s*' diff --git a/user-feedback.md b/user-feedback.md new file mode 100644 index 000000000..d69d4ee3c --- /dev/null +++ b/user-feedback.md @@ -0,0 +1,19 @@ +## Issues + +If you have any problems with or questions about this image, please contact us +%%MAILING_LIST%% through a [GitHub issue](%%GITHUB_REPO%%/issues). + +You can also reach many of the official image maintainers via the +`#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large or small; +we are always thrilled to receive pull requests, and do our best to process them +as fast as we can. + +Before you start to code, we recommend discussing your plans %%MAILING_LIST%% +through a [GitHub issue](%%GITHUB_REPO%%/issues), especially for more ambitious +contributions. This gives other contributors a chance to point you in the right +direction, give you feedback on your design, and help you find out if someone +else is working on the same thing.