Installation

Requirements

All systems:

Ocrocis can be installed via Docker which takes care of all dependencies, including those of Ocropy.

The idea of Docker is to deliver pre-packaged containers of software that just need to be built and run.

How to get Docker

Linux

You can use your package manager to install docker (or docker.io in Ubuntu). Docker is under heavy development (February 2015), so please make sure that you are installing a current version (1.5.1 as of Feb 2015).

If in doubt, install Docker yourself, for example on Ubuntu:

http://docs.docker.com/installation/ubuntulinux/

Mac OS X

Install Xcode (https://itunes.apple.com/en/app/xcode/id497799835?mt=12) and its command line tools:

xcode-select --install

Install the Docker environment for OS X (see https://docs.docker.com/installation/mac/). It is recommended to use the package manager Homebrew (http://brew.sh):

brew install Caskroom/cask/virtualbox docker boot2docker

The following two instructions are given by the boot2docker install routine and are repeated here for convenience. Let launchd start boot2docker at login and then load boot2docker:

ln -sfv /usr/local/opt/boot2docker/*.plist ~/Library/LaunchAgents
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.boot2docker.plist

Finally, initialize, start and export boot2docker:

boot2docker init
boot2docker start
$(boot2docker shellinit)

The last two steps, start and shellinit, have to be repeated in each new shell you open. Ocrocis will handle that for you, so you don't have to worry about it.

Now your Docker should be ready to go on OS X. Test it like so:

docker run hello-world

How to get Ocropy for manual installation

See https://github.com/tmbdev/ocropy.

Note that the manual installation of Ocropy requires sudo privileges and is known to have some issues on OS X.

Installing Ocrocis

Download or clone Ocrocis from https://github.com/kmnns/ocrocis. Then open your terminal and enter the installation directory.

Run the installation with your preferred installation method. There are two options:

  1. ./install with-docker : builds the Docker image and installs Ocrocis as Docker+Perl application.
  2. ./install perl-only : installs Ocrocis as Perl-only application. Use this method if you already have Ocropy installed or want to install it manually.

Notes: