Try DocView Capture with Docker

The quickest way to try DocView Capture is Docker. One command starts the website, a DocView Worker and a SQL Server Express database. Then you finish in the browser, in the setup wizard.

What you need

• Docker Desktop (Windows or Mac) or Docker Engine with Compose (Linux). See https://docs.docker.com/get-docker/.
• 4 CPU cores and 8 GB of memory for Docker (16 GB with DocView OmniRead).
• The DocView Capture source or release folder, which has the file docker-compose.yml.

Start it

1. Open a terminal in the folder with docker-compose.yml.

2. Run:

   docker compose up -d
   

   The first time, this builds the images, which takes 5–15 minutes. After that it starts in under a minute.

3. Open http://localhost:8080. The setup wizard opens.

4. The database and storage are already set, so the wizard starts at Administrator. Create your account and finish the other steps.

From another computer, the wizard first asks for the setup token. To see it, run:

docker compose logs web | grep -i "setup token"

Change the settings

Copy .env.example to .env and change the values, then run docker compose up -d again. The most useful ones:

Important: Set MSSQL_SA_PASSWORD before the first start. It cannot be changed afterwards in .env alone.

More DocView Workers

docker compose up -d --scale worker=3

DocView OmniRead

1. In .env, set a key of your choice and the service address:

   DOCVIEW_OMNIREAD_KEY=<44 random letters and digits>
   DOCVIEW_OMNIREAD_URLS=http://omniread:5300
   

2. Run:

   docker compose --profile omniread up -d
   

DocView picks up the address and key by itself. The models are downloaded the first time they are needed. See DocView OmniRead.

Images from a registry

Instead of building the images, you can use ready-made ones. Set DOCVIEW_REGISTRY (for example ghcr.io/devsoftuk/) and DOCVIEW_TAG (for example 1.4.0) in .env, then run docker compose pull and docker compose up -d.

Update

docker compose pull      # with a registry
docker compose build     # or: build again from the new source
docker compose up -d

The database is upgraded automatically on the first start of the new version. See Upgrading.

Stop or remove

• docker compose stop stops everything. docker compose start starts it again.
• docker compose down removes the containers. Your data stays in Docker volumes.
• docker compose down -v also deletes the database and all page images.

For production

Docker Compose on one server is fine for a trial or a small office. For production:

• put a reverse proxy with HTTPS in front of the website and add ReverseProxy__Enabled=true to the web app's settings;
• back up the docview-sql and docview-storage volumes;
• or use a cloud template: Azure, AWS or Google Cloud.

Next steps

• The setup wizard
• Quick start