Docuvision Studio

• Indexes documents using Docuvision and stores the results in elastic search.
• Explore the content using our web interface

NOTE: This is a alpha release and we would like to encourage you to send us any feedback.

Prerequisites

• Docker

• docker-compose

• Docuvision API key

Getting started

In a terminal, from the same folder as this README, copy the ./docker/.env.example to ./docker/.env:

cp ./docker/.env.example ./docker/.env

Edit the text file ./docker/.env and replace <put_your_api_key_here> with your Docuvision api key.

COMPOSE_PROJECT_NAME=ds
COMPOSE_CONVERT_WINDOWS_PATHS=1

# where files to be indexed will live
INPUT_DIR=../input-files

# where the program stores output files like images and json
GENERATED_DIR=../generated-files

# Your super secret API key
DOCUVISION_APIKEY=<put_your_api_key_here>

So your .env would look something like this:

COMPOSE_PROJECT_NAME=ds
COMPOSE_CONVERT_WINDOWS_PATHS=1

# where files to be indexed will live
INPUT_DIR=../input-files

# where the program stores output files like images and json
GENERATED_DIR=../generated-files

# Your super secret API key
DOCUVISION_APIKEY=7MQBbPTUin3xPVCGv*JdxKUf2X*Oo65yDyjBa&rEnri!MJ!ZYe6XRE9$cge5fY

Finally, start docker:

cd ./docker && docker-compose up -d

Any files placed in the input-files folder will be indexed automagically (see advanced usage for configuration options).

Aditionally, content generated by the indexer will be put into the generated-files folder.

That's it. The Docuvisionary client will start up (after a short wait) and you can visit http://localhost:8100 to see your search client.

Troubleshooting

If you see the warning

   WARNING: The DOCUVISION_APIKEY variable is not set. Defaulting to a blank string.

it means you have not configured your Docuvision api key correctly. Make sure your api key is in the docker/.env file

FAQ

Q: Where can I get a Docuvision API key?
A: You can sign up at https://docuvision.io/

Q: Why can't I just add my API key to .env.example instead?
A: By convention, .env files are normally ignored in git, so you won't risk accidentally showing the world your super secret key. Any public environment variables can safely go into .env.example to be copied over.

Advanced

Changing the default indexer folder

By default, the INPUT_DIR variable in docker/.env is set to the input-files folder. You can change that to another location which will be watched for changes.

**WARNING**: make sure the folder exists before starting the indexer, otherwise it will be created with the wrong permissions and will only run once on start instead of watching for changes.

Examples:

Using the full path:

INPUT_DIR=/home/docuvison-lover/Media/cat-folder

Using a relative path (from the docker folder)

INPUT_DIR=../../../Media/cat-folder

Windows paths also work

INPUT_DIR=C:\Users\docuvison-lover\Media\cat-folder