https://github.com/200ok-ch/okdoc
A self-contained document scanning and archiving solution.
https://github.com/200ok-ch/okdoc
Last synced: 7 months ago
JSON representation
A self-contained document scanning and archiving solution.
- Host: GitHub
- URL: https://github.com/200ok-ch/okdoc
- Owner: 200ok-ch
- License: agpl-3.0
- Created: 2020-09-28T09:30:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T09:42:03.000Z (almost 3 years ago)
- Last Synced: 2025-01-20T10:09:30.287Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 119 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
#+begin_example
___ | | ____| | ___ ___
/ _ \| |/ / _` |/ _ \ / __|
| (_) | < (_| | (_) | (__
\___/|_|\_\__,_|\___/ \___|
#+end_example
* 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
#+begin_src shell
git submodule add git@github.com:200ok-ch/okdoc.git
ln -s okdoc/Makefile Makefile
make install
#+end_src
** 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=