Author: tpalsulich
Date: Fri Mar 27 18:18:19 2015
New Revision: 1669644
URL: http://svn.apache.org/r1669644
Log:
TIKA-1583. Convert tika-server README to markdown.
Added:
tika/trunk/tika-server/README.md
Added: tika/trunk/tika-server/README.md
URL:
http://svn.apache.org/viewvc/tika/trunk/tika-server/README.md?rev=1669644&view=auto
==============================================================================
--- tika/trunk/tika-server/README.md (added)
+++ tika/trunk/tika-server/README.md Fri Mar 27 18:18:19 2015
@@ -0,0 +1,43 @@
+This is JAX-RS Tika server for Apache Tika
(https://issues.apache.org/jira/browse/TIKA-593)
+
+Running
+-------
+```
+$ java -jar tika-server/target/tika-server.jar --help
+ usage: tikaserver
+ -?,--help this help message
+ -h,--host <arg> host name (default = localhost)
+ -l,--log <arg> request URI log level ('debug' or 'info')
+ -p,--port <arg> listen port (default = 9998)
+ -s,--includeStack whether or not to return a stack trace
+ if there is an exception during 'parse'
+```
+
+Usage
+-----
+Usage examples from command line with `curl` utility:
+
+* Extract plain text:
+`curl -T price.xls http://localhost:9998/tika`
+
+* Extract text with mime-type hint:
+`curl -v -H "Content-type:
application/vnd.openxmlformats-officedocument.wordprocessingml.document" -T
document.docx http://localhost:9998/tika`
+
+* Get all document attachments as ZIP-file:
+`curl -v -T Doc1_ole.doc http://localhost:9998/unpacker > /var/tmp/x.zip`
+
+* Extract metadata to CSV format:
+`curl -T price.xls http://localhost:9998/meta`
+
+* Detect media type from CSV format using file extension hint
+`curl -X PUT -H "Content-Disposition: attachment; filename=foo.csv"
--upload-file foo.csv http://localhost:9998/detect/stream`
+
+
+HTTP Return Codes
+-----------------
+`200` - Ok
+`204` - No content (for example when we are unpacking file without attachments)
+`415` - Unknown file type
+`422` - Unparsable document of known type (password protected documents and
unsupported versions like Biff5 Excel)
+`500` - Internal error
+
