Merge pull request #76 from infosiftr/crate

Add crate, allow custom user-feedback section

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%%

crate/README-short.txt

@@ -0,0 +1 @@
+Crate is a shared nothing, fully searchable, document oriented cluster datastore

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-dir>:/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).

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-dir>:/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/).

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.

crate/user-feedback.md

@@ -0,0 +1,19 @@
+## 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).

update.sh

@@ -24,6 +24,7 @@ declare -A otherRepos=(
 	[centos]='https://github.com/CentOS/sig-cloud-instance-images'
 	[cirros]='https://github.com/ewindisch/docker-cirros'
 	[clojure]='https://github.com/Quantisan/docker-clojure'
+	[crate]='https://github.com/crate/docker-crate'
 	[crux]='https://github.com/therealprologic/docker-crux'
 	[debian]='https://github.com/tianon/docker-brew-debian'
 	[docker-dev]='https://github.com/docker/docker'
@@ -61,6 +62,8 @@ for repo in "${repos[@]}"; do
 			mailingList=' '
 		fi
 		
+		userFeedback="$(cat "$repo/user-feedback.md" 2>/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*'
 		

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.