From 9c0f8feaed4337e795286dc0b576065ed622db57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Igor=20T=C3=A1mara?= Date: Thu, 8 Jan 2015 15:34:38 -0500 Subject: [PATCH] Added documentation for brew users When working on OSX, brew users would be happier with this doc Conflicts: docs/topics/installation.rst --- docs/topics/installation.rst | 82 ++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst index b0cbffad35..3f7204eb84 100644 --- a/docs/topics/installation.rst +++ b/docs/topics/installation.rst @@ -40,6 +40,88 @@ it very easy to start using **Mayan EDMS**. Populate the database with the proje Point your browser to http://127.0.0.1:8000. If everything was installed correctly you should see the login screen and panel showing a randomly generated admin password. +======= +Mac OSX +------- + +**Mayan EDMS** is dependant on a number of binary packages and the recommended way is +to use a package manager such as `MacPorts `_ or `Homebrew `. + + +Use MacPorts to install binary dependencies +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +With MacPorts installed run the command: + +.. code-block:: bash + + sudo port install python-dev gcc tesseract-ocr unpaper python-virtualenv ghostscript libjpeg-dev libpng-dev poppler-utils + +**Mayan EDMS** can use either Pillow, ImageMagick or GraphicsMagick as the backend to +convert images so in addition you can install GraphicsMagick ... + +.. code-block:: bash + + sudo port install graphicsmagick + +Set the Binary paths +******************** + +**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs +so either you can symlink the binaries installed via MacPorts in /opt/local/bin/ +to /usr/bin/ with ... + +.. code-block:: bash + + sudo ln -s /opt/local/bin/tesseract /usr/bin/tesseract && \ + sudo ln -s /opt/local/bin/identify /usr/bin/identify && \ + sudo ln -s /opt/local/bin/gs /usr/bin/gs + +... alternatively set the paths in the ``settings/locals.py`` + +.. code-block:: python + + # document converters + CONVERTER_IM_CONVERT_PATH = '/opt/local/bin/convert' + IM_IDENTIFY_PATH = '/opt/local/bin/identify' + GRAPHICS_BACKEND = 'converter.backends.graphicsmagick.GraphicsMagick' + GM_PATH = '/opt/local/bin/gm' + LIBREOFFICE_PATH = '/Applications/LibreOffice.app/Contents/MacOS/soffice' + +Or Use Homebrew +~~~~~~~~~~~~~~~ + +With Homebrew installed run the command: + +.. code-block:: bash + + brew install python gcc tesseract unpaper poppler libpng graphicsmagick postgresql + +Set the Binary paths +******************** + +**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs +so either you can symlink the binaries installed via brew in /usr/local/bin/ +to /usr/bin/ with ... + +.. code-block:: bash + + sudo ln -s /usr/local/bin/tesseract /usr/bin/tesseract && \ + sudo ln -s /usr/local/bin/identify /usr/bin/identify && \ + sudo ln -s /usr/local/bin/unpaper /usr/bin/unpaper && \ + sudo ln -s /usr/local/bin/pdftotext /usr/bin/pdftotext && \ + sudo ln -s /usr/local/bin/gs /usr/bin/gs && \ + +... alternatively set the paths in the ``settings/locals.py`` + +.. code-block:: python + + # document converters + CONVERTER_IM_CONVERT_PATH = '/usr/local/bin/convert' + IM_IDENTIFY_PATH = '/usr/local/bin/identify' + GRAPHICS_BACKEND = 'converter.backends.graphicsmagick.GraphicsMagick' + GM_PATH = '/usr/local/bin/gm' + LIBREOFFICE_PATH = '/Applications/LibreOffice.app/Contents/MacOS/soffice' Production use --------------