Index: src/site/apt/1.23/gettingstarted.apt =================================================================== --- src/site/apt/1.23/gettingstarted.apt (revision 1873646) +++ src/site/apt/1.23/gettingstarted.apt (working copy) @@ -20,7 +20,7 @@ Getting Started with Apache Tika This document describes how to build Apache Tika from sources and - how to start using Tika in an application. + how to start using Tika in an application or as a RESTful service. Getting and building the sources @@ -62,9 +62,12 @@ line interface. [tika-server/target/tika-server-*.jar] - Tika JAX-RS REST application. This is a Jetty web server running Tika + Tika RESTful server. This is a Jetty web server running Tika REST services as described in {{{http://wiki.apache.org/tika/TikaJAXRS}this page}}. + [tika-server/target/tika-server-*-bin.tar] + Tika server wrapped up as an installable Unix service. + [tika-bundle/target/tika-bundle-*.jar] Tika bundle. An OSGi bundle that combines tika-parsers with non-OSGified parser libraries to make them easy to deploy in an OSGi environment. @@ -79,8 +82,8 @@ Using Tika as a Maven dependency The core library, <<< tika-core >>>, contains the key interfaces and classes - of Tika and can be used by itself if you don't need the full set of parsers - from the <<< tika-parsers >>> component. The tika-core dependency looks like + of Tika and can be used by itself if you don't need the full set of parsers + from the <<< tika-parsers >>> component. The tika-core dependency looks like this: --- @@ -92,7 +95,7 @@ --- If you want to use Tika to parse documents (instead of simply detecting - document types, etc.), you'll want to depend on <<< tika-parsers >>> instead: + document types, etc.), you'll want to depend on <<< tika-parsers >>> instead: --- @@ -127,7 +130,7 @@ Using Tika in an Ant project If you are using {{{http://ant.apache.org/ivy/}Apache Ivy}} as your - dependency manager tool with Ant, then to include Tika with the full set + dependency manager tool with Ant, then to include Tika with the full set of parsers, you should depend on the <<< tika-parsers >>> artifact like this: --- @@ -290,5 +293,72 @@ Wrappers - Several wrappers are available to use Tika in another programming language, + Several wrappers are available to use Tika in another programming language, such as {{{https://github.com/aviks/Taro.jl}Julia}} or {{{https://github.com/chrismattmann/tika-python}Python}}. + A complete listing is available on {{{https://cwiki.apache.org/confluence/display/TIKA/API+Bindings+for+Tika}the wiki}}. + +Using Tika as a RESTful Service + + The Tika server jar (tika-server-*.jar) can be run as a RESTful services. This + runnable jar contains all the dependencies it needs, so you don't need to worry about classpath settings to run it. + More information on deploying Tika as a service process, including via Docker is available + on {{{https://cwiki.apache.org/confluence/display/TIKA/TikaJAXRS}the wiki}}. + + The usage instructions are shown below. + +--- +usage: java -jar tika-server.jar --help + +-?,--help this help message +-C,--cors origin allowed to make CORS requests + (default=NONE) + all allowed if "all" +-c,--config Tika Configuration file to override + default config with. +-child Only in spawn child mode: this process is + a child process -- do not use this! Should + only be invoked by parent process +-childStatusFile Only in spawn child mode: temporary file + used as mmap to communicate with parent + process -- do not use this! Should only be + invoked by parent process. +-d,--digest include digest in metadata, e.g. + md5,sha1:32,sha256 +-dml,--digestMarkLimit max number of bytes to mark on stream for + digest +-enableFileUrl allows user to pass in fileUrl instead of + InputStream. +-enableUnsecureFeatures this is required to enable fileUrl. +-h,--host host name (default = localhost, use * for + all) +-javaHome Only in spawn child mode: override system + property JAVA_HOME for calling java for + the child process +-l,--log request URI log level ('debug' or 'info') +-maxChildStartupMillis Only in spawn child mode: Maximum number + of millis to wait for the child process to + startup. +-maxFiles Only in spawn child mode: shutdown server + after this many files (to handle parsers + that might introduce slowly building + memory leaks); the default is 100000. Set + to -1 to turn this off. +-maxRestarts Only in spawn child mode: how many times + to restart child process, default is -1 + (always restart) +-p,--port listen port (default = 9998) +-pingPulseMillis Only in spawn child mode: how often to + check if a ping has timed out. +-pingTimeoutMillis Only in spawn child mode: how long to wait + to wait for a ping and/or ping response. +-s,--includeStack whether or not to return a stack trace + if there is an exception during 'parse' +-spawnChild whether or not to spawn a child process + for robustness +-taskPulseMillis Only in spawn child mode: how often to + check if a task has timed out. +-taskTimeoutMillis Only in spawn child mode: how long to wait + for a task (e.g. parse) to finish +-tmpFilePrefix Only in spawn child mode: prefix for temp + file - for debugging only +---