📝 ppn2ocr: Add to README, including proxy configuration

pull/27/head
Gerber, Mike 5 years ago
parent 1585247482
commit 7c5cbc7244

@ -55,3 +55,23 @@ available:
~~~ ~~~
firefox OCR-D-OCR-CALAMARI-EVAL/OCR-D-OCR-CALAMARI-EVAL_00000024.html firefox OCR-D-OCR-CALAMARI-EVAL/OCR-D-OCR-CALAMARI-EVAL_00000024.html
~~~ ~~~
ppn2ocr
-------
The `ppn2ocr` script produces OCR output for a given document in the State
Library Berlin (SBB)'s digitized collection. The document must be specified by its
PPN, for example:
~~~
./ppn2ocr PPN77164308X
~~~
This produces a workspace directory `PPN77164308X` with the OCR results in it;
the results are viewable as explained above.
ppn2ocr requires a working Docker setup and properly set up environment
variables for the proxy configuration. At SBB, this means:
~~~
export HTTP_PROXY=http://http-proxy.sbb.spk-berlin.de:3128/
export HTTPS_PROXY=$HTTP_PROXY; export http_proxy=$HTTP_PROXY; export https_proxy=$HTTP_PROXY
export no_proxy=localhost,digital.staatsbibliothek-berlin.de,content.staatsbibliothek-berlin.de
~~~

@ -67,9 +67,6 @@ $self_dir/run-docker-hub -I PRESENTATION --skip-validation
# TODO # TODO
# * README: Users must configure their proxy properly via environment variables;
# This includes setting no_proxy (e.g. for use at SBB).
# my_ocrd_workflow # my_ocrd_workflow
# ---------------- # ----------------
# * Need option to add volumes e.g. /srv/digisam_images # * Need option to add volumes e.g. /srv/digisam_images

Loading…
Cancel
Save