Skip to content

200ok-ch/okdoc

Repository files navigation

  ___ | | ____| | ___   ___
 / _ \| |/ / _` |/ _ \ / __|
| (_) |   < (_| | (_) | (__
 \___/|_|\_\__,_|\___/ \___|

Welcome to okdoc

This repo contains a document scanning and archiving solution. Given (scanned) PDF files, it will make them full-text searchable and sorts them based on rules.

Usage

You can call make yourself, or…

Just commit and push a PDF file to the documents repo and let the magic happen. (CI will do it for you.)

Sorting

There is a Ruby script called sort which will move files in this repo based on rules defined in config.yml. Check this file for more information.

Installation

git submodule add git@github.com:200ok-ch/okdoc.git
ln -s okdoc/Makefile Makefile
make install

Setup Gitlab CI

  1. Create a new repo on Gitlab
  2. Add a new bot on Gitlab (Or use an existing bot for your context)
  3. Impersonate the bot
  4. Create a Access Token with all permissions
  5. Exit impersonation
  6. Make the bot a member of the new repo
  7. Make the pi-bot a member of the new repo if you want to use the scanner
  8. Got to “Project > Settings > CI / CD”
  9. Run DOCKER_TAG=gitlab.200ok.ch:5050/200ok/documents/ci-runner make build-ci to build and upload the customer CI runner (change the name to what you want)
  10. Add variable CI_GIT_BOT with the bot’s login
  11. Add variable DOCKER_TAG with the same DOCKER_TAG as in #9
  12. Add variable CI_GIT_TOKEN with the bot’s token (Protected and masked)
  13. Adjust image and bot name in .gitlab-ci.yml