Unofficial next gen user interface for Apache Tika
This is an initial draft of the next generation user interface application for Apache Tika. This is not part of the Apache Tika project.
Configuring Apache Tika is complex. This project offers a user interface to make that easier. Specifically, the GUI:
- generates the XML configuration file for use by the standard Apache Tika tika-app jar
- includes the extra dependencies required by the configuration in the XML configuration file.
As a side note, to replicate what the gui is doing...
- Configure and run a job in the GUI.
- Find the latest tika-config.xml that was generated by the GUI in the
.../config/directory -- for exampletika-gui-app-1.0.0-BETA7-bin/config/tika-config-xyz.xml. - Run tika-app on the commandline with this config file. You'll need to add the relevant extra dependencies and specify this config file like so:
Commandline on a linux based system:
jre/bin/java -Dlog4j.configurationFile=config/log4j2-async-cli.xml -cp "tika-gui-app-1.0.0-BETA7-bin/lib/tika-core/*:tika-gui-app-1.0.0-BETA7-bin/lib/tika-extras/*:tika-gui-app-1.0.0-BETA7-bin/lib/db/h2/*:tika-gui-app-1.0.0-BETA7-bin/lib/tika-emitter-jdbc/*" org.apache.tika.async.cli.TikaAsyncCLI tika-gui-app-1.0.0-BETA7-bin/config/tika-config-5449427994870420796.xml"
NOTE: When you run a batch job from the GUI App, the Tika gui will output the comma-delimited commandline after org.tallison.tika.app.fx.batch.BatchProcess built commandline:
Download the .zip file in the releases section for your operating system.
- Unzip then run
tika-gui.bat
- Unzip then run
./tika-gui-mac-x86.shor./tika-gui-mac-aarch64.sh
NOTE I've been able to run the mac distro on a mac aarch64. There's a warning about javafx stuff, but it seems to work
- Unzip then
./tika-gui.sh
This project requires a Java 21 jdk/jre with java-fx built in! We use Azul's Zulu jdk-fx for development, and we bundle Zulu jre-fx with the release artifacts. To download: www.azul.com.
As of org.apache's parent v 35, you'll need to turn on the apache-snapshots profile:
mvn clean install -P use-apache-snapshots
This is just the beginning. Everything is still in a state of flux and is subject to change. We may abandon the whole thing and do something in Electron...
HELP WANTED!!!
This breaks substantially from Tika's current user interface.
This will make use of the tika-pipes modules to enable fetching files from local file shares, S3 and other resources and then emitting the parsed output to local file shares, S3, OpenSearch, Apache Solr, jdbc, etc.
This requires Java 21 (with built-in java-fx) and will not run Tika "in process", but rather it will rely on forking Tika.
There's quite a bit of work to streamline the releases so that we don't have 16 copies of jackson-databind, for example...
Ideally, there will be some user interface to visualize information from a run of Tika via tika-eval.
- 1.0.0-BETA7 -- updated dependencies. Now requires Java 21.
- 1.0.0-BETA6 -- same warning as BETA5 -- only use this as a demo until commons-compress regressions have been fixed.
- 1.0.0-BETA5 -- this has known regressions in commons-compress and should be used for demo purposes only.
At some point, we should use jreleaser. We aren't yet doing that.
To generate the download sections of the pom, run DownloadPluginUpdater and PackageBinaries.
The release is currently triggered by pushing a tag starting with 'v'.
Before running this, change the version to the version you intend to release.
git tag -a "v1.0.0-BETA5" -m "v1.0.0-BETA5 release" && git push origin v1.0.0-BETA5
Change the version back to the development/SNAPSHOT version.
If you need to re-release, delete the tag:
git push --delete origin v1.0.0-BETA5 && git tag --delete v1.0.0-BETA5
We should figure out how to sign artifacts and offer sha256s. Again, see jreleaser above.
Further, short of going the full jreleaser route, we should start using: appassembler-maven-plugin.