various improvements

doc/README.Synology.txt

@@ -1,14 +1,16 @@
 *********************************************
-How to set up SeedDMS Preview on Synology NAS
+How to set up a Synology NAS to run SeedDMS
 *********************************************
 
+**This guide has been updated and tested to work on Synology DSM 6.0. It should as well work with older DMS versions, however some steps or paths may be different.**
+
 Introduction
 ############
-SeedDMS provides a function creating a preview of each document which is displayed on the document page.
+SeedDMS is a feature rich and lightweight document management system. Unfortunately, some of the tools which are part of many Linux distros, have not been made available by
+Synology and therefore require additional steps to bring them to your Synology.
 
-Synology stations do not support the creation of the previews by default due to a missing Ghostscript implementation. Therefore
+This guide covers the installation of the required tools to have all features of SeedDMS available. It does not cover the installation of 3rd party programs (like OPKG). It
-loading of a document page can use a lot of time because SeedDMS tries to create the missing preview images each time the document
+does not cover the installation of SeedDMS as well, please refer to the separate README.Install.md file.
-page is being loaded.
 
 Prerequisites
 #############
@@ -20,7 +22,7 @@ In order to complete the steps outlined below, you must be able to carry out the
 To complete the installation, the following prerequisites on your Synology must be met:
 
 * IPKG or OPKG (OPKG preferred) installed
-* Pear Package SeedDMS_Preview already installed
+* PEAR installed from the Synology Package Center
 
 Installation and configuration
 ##############################
@@ -31,8 +33,8 @@ must be done on the terminal.
 Install Ghostscript
 ***************************
 
-The first step is to install Ghostscript to make ImageMagick capable of converting PDF files to images. Use IPKG or OPKG to complete this
+The first step is to install Ghostscript to make ImageMagick capable of converting PDF files to images which are then used for previews.
-step.
+Use IPKG or OPKG to complete this step.
 
 Make Ghostscript available to PHP
 *****************************************
@@ -42,21 +44,10 @@ use phpinfo and find **_SERVER["PATH"]**. If you can't find /opt inside, PHP can
 update the paths or just make a symlink.
 To create the symlink, cd to /usr/bin and type *ln -s /opt/bin/gs gs*. Verify the created symlink.
 
-Fix Ghostscript package bug
-****************************************
-
-Unfortunately the version delivered by OPKG has a bug, making Ghostscript failing to work properly. The bug requries fixing at the time
-of the writing are the following:
-
-* Resource path pointing to a wrong version (9.10 instead of 9.16)
-
-First, fix the resource path. Go to /opt/bin and find **gs** in there. Open the file with VI. Change the GS_LIB path from */opt/share/ghostscript/9.10/Resource*
-to */opt/share/ghostscript/9.16/Resource*. This will now allow Ghostscript to find it's files in the proper path.
-
 Fix ImageMagick
 ********************
 
-Not only Ghostscript is affected by bugs, the default configuration files are missing. Unfortunately some work is required here as well.
+Not only Ghostscript is affected by bugs, the default configuration files for ImageMagick are missing. Unfortunately some work is required here as well.
 
 To check where ImageMagick looks for it's files, invoke the command *convert -debug configure logo: null:*. You will see some paths shown, these
 are the paths where ImageMagic tries to locate it's configuration files. The first path shown will point to */usr/share/ImageMagick-6* followed by the
@@ -99,11 +90,74 @@ If you want to test Ghostcript as well, invoke the follwing command:
 
 This command should go through without any errors and as well output a png file.
 
-If the tests above are successful, you are ready to use SeedDMS Preview. Go to your SeedDMS Installation and open a folder. For the first test you
+If the tests above are successful, you are ready to use SeedDMS Preview.
-may take a folder with less files in it. Be patient while the previews are generated. You may check the process using *top* on the terminal.
 
-At the end your document page should show the previews like shown below:
+Install PEAR packages
+*********************
 
-.. figure:: preview.png
+This step is similar to the installation on other Linux distros. Once you installed PEAR from the Package Center you can call it from the command line.
-   :alt: Document previews
+
-   :scale: 75%
+The following packages are required by SeedDMS:
+
+* Auth_SASL
+* HTTP_WebDAV_Server
+* Log
+* Mail
+* Net_SMTP
+
+Install these packages, then go to the next step.
+
+Install additional packages
+***************************
+
+SeedDMS uses other small tools (for example the Slim Framework) to add some additional functionality. At the moment (Version 5.0.x) the list contains the following
+tools:
+
+* FeedWriter
+* Slim
+* parsedown
+
+Copy the tools to a folder on your Synology. Using the console, copy the tools to **/volume1/@appstore/PEAR**.
+Copy the whole folders as they are and do not change the structure. As the PEAR directory is already within
+the PHP include path, no further configuration is required to get them working.
+
+Fulltext Index
+***************
+
+If you do not intend to use the fulltext index, please skip this section and continue with the readme file to
+install SeedDMS.
+
+To create the fulltext index, SeedDMS needs to be able to convert the documents to text files to read the terms
+out. Pdftotext is already available by default, so we just need to take care of the Microsoft Office formats.
+
+For this guide, the following two tools have been selected:
+
+docx2txt available from http://docx2txt.sourceforge.net/
+
+xlsx2csv available from http://github.com/dilshod/xlsx2csv
+
+Copy both files to your Synology.
+
+**docx2txt**
+
+This program runs without any kind of installation. Create a folder on your Synology and extract the contents of the archive.
+
+In SeedDMS you can now configure the setting for Word documents to the path where you extracted the files in the step before. Point
+to the docx2txt.sh file and you are done.
+
+To make the configuration more simple you can add a symlink in **/usr/bin**. This will allow you to call docx2txt from any location of your Synology.
+The symlink must point to docx2txt.sh to get it working. In SeedDMS you can now just configure docx2txt followed by any additional commands.
+
+**xlsx2csv**
+
+This one must be installed to get it working. The installation script is written in Python, so you need to get Python installed on your Synology.
+As the version available from Synology does not properly work (you can't install PIP) it is strongly recommended to use OPKG or IPKG to install Python.
+
+Install Python and PIP. Once completed, point to the directory where you copied xlsx2csv. Unpack the archive, then execute the installer (pip install xlsx2csv).
+
+Once completed, xlsx2csv is available and can be configured within SeedDMS.
+
+Complete the installation
+*************************
+
+Now you are ready to install SeedDMS and configure the database. Follow the README file to install SeedDMS.