Containers

Running containers manually

PostgreSql

Note: the command is for reference only. You need to configure access such as password.

docker run --name postgres \
    -d --restart=unless-stopped \
    --env-file=env \
    -v /data/db/postgres/data:/var/lib/postgresql/data \
    postgres:13-alpine

Meilisearch

Meilisearch has data and its own environment values, such as master-key. This is optional, though it’s recommended to set the master-key, especially if exposing Meilisearch server. Be sure to add the master-key to Virtualpaper configuration if set.

docker run --name=virtualpaper-meilisearch -d \
    --restart=unless-stopped \
    -v /my-local-dir/meilisearch/data.ms:/data.ms \
    getmeili/meilisearch:v0.25.2

Virtualpaper server

  1. Copy the config file config.sample.toml into target directory, e.g.: /my-local-dir/virtualpaper/config/config.toml
  2. Configure the configuration file as needed. Database and Meilisearch connection must be working before further initialization can be done.
  3. Start the server:
docker run --name=virtualpaper -d \
    -p 127.0.0.1:8000:8000 \
    --restart=unless-stopped \
    -v /my-local-dir/virtualpaper/config:/config \
    -v /my-local-dir/virtualpaper/data:/data \
    -v /usr/share/tesseract-ocr/4.00/tessdata:/usr/share/tessdata \
    tryffel/virtualpaper:latest
  1. Add user:
docker exec -it virtualpaper /bin/sh
/app/virtualpaper manage add-user --config /config/config.toml
  1. Head over to the web page, which is by default accessible at http://localhost:8000.

See CLI instructions for more help on how to use the command line interface.

Tesseract

Be sure to install tesseract-ocr language files in host OS or by extending to Docker image. E.g in Debian, install package tesseract-ocr-eng for Enlgish support.

See more on manual installation