This is an automated email from the ASF dual-hosted git repository.
dmeikle pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tika-docker.git
The following commit(s) were added to refs/heads/master by this push:
new e6c1c23 Updated README
e6c1c23 is described below
commit e6c1c2380a263370998c8bec9c6fdcf2ad87842c
Author: Dave Meikle <[email protected]>
AuthorDate: Thu Feb 6 04:44:01 2020 +0000
Updated README
---
README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 63 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 773b484..34eafa5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,64 @@
-# tika-docker
+# tika-docker [](https://travis-ci.org/apache/tika-docker)
-Work in Progress
\ No newline at end of file
+This repo is used to create convenience Docker images published on
[DockerHub](https://hub.docker.com/r/apache/tika) by the [Apache
Tika](http://tika.apache.org) Dev team for Apache Tika Server.
+
+The images create a functional Apache Tika Server instance that contains the
latest Ubuntu running the appropriate version's server on Port 9998 using Java
8 (until version 1.20) and then Java 11 (1.21 and above).
+
+There is a minimal version, which contains only Apache Tika and it's core
dependencies, and a full version, which also includes dependencies for the GDAL
and Tesseract OCR parsers. To balance showing functionality versus the size of
the full image, this file currently installs the language packs for the
following languages:
+* English
+* French
+* German
+* Italian
+* Spanish.
+
+To install more languages simply update the apt-get command to include the
package containing the language you required, or include your own custom packs
using an ADD command.
+
+## Usage
+
+You can pull down the version you would like using:
+
+ docker pull apache/tika:<version>
+
+Then to run the container, execute the following command:
+
+ docker run -d -p 9998:9998 apache/tika:<version>
+
+Where <version> is the Apache Tika Server version - e.g. 1.23, 1.22,
1.23-full, 1.22-full.
+
+NOTE: The latest and latest-full tags are explicitly set to the latest
released version when they are published.
+
+## Building
+
+To build the image from scratch, simply invoke:
+
+ docker build -t 'apache/tika' github.com/apache/tika-docker
+
+You can then use the following command (using the name you allocated in the
build command as part of -t option):
+
+ docker run -d -p 9998:9998 apache/tika
+
+## More Information
+
+For more infomation on Apache Tika Server, go to the [Apache Tika Server
documentation](http://wiki.apache.org/tika/TikaJAXRS).
+
+For more information on Apache Tika, go to the official [Apache
Tika](http://tika.apache.org) project website.
+
+For more information on the Apache Software Foundation, go to the [Apache
Software Foundation](http://apache.org) website.
+
+## Authors
+
+Apache Tika Dev Team ([email protected])
+
+## Contributors
+
+There have been a range of
[contributors](https://github.com/apache/tika-docker/graphs/contributors) on
GitHub and via suggestions, including:
+
+- [@grossws](https://github.com/grossws)
+- [@arjunyel](https://github.com/arjunyel)
+- [@mpdude](https://github.com/mpdude)
+- [@laszlocsontosuw](https://github.com/laszlocsontosuw)
+
+
+## Disclaimer
+
+It is worth noting that whilst these Docker images download the binary JARs
published by the Apache Tika Team on the Apache Software Foundation
distribution sites, only the source release of an Apache Software Foundation
project is an official release artefact. See [Release Distribution
Policy](https://www.apache.org/dev/release-distribution.html) for more details.
