Documentation for the new feature

master
Y 2016-01-26 23:05:49 +01:00
parent d1c5cae9f8
commit 041eb96343
1 changed files with 3 additions and 3 deletions

6
README
View File

@ -28,11 +28,11 @@ Finally, all the input (search terms, etc.) is verified by the CLI script, so th
= INSTALLATION AND DEPENDENCIES =
The script may be copied anywhere. Its dependencies are standard, although I only tested on Debian: bash, find, gawk, sed, grep, file, ls.
Once the script is installed, the path to the Paperwork data must be changed (edit the script).
The script may be copied anywhere. Its dependencies are standard, although I only tested on Debian: bash, find, gawk, sed, grep, file, base64, ls. Besides, if pdfinfo and pdftoppm are installed, the script detects these and handles the pages from PDF documents in an individual manner (as JPEG images), instead of returning the whole document when a single page is requested.
Once the script is installed, the path to the Paperwork data must be changed (edit the script). Optionally, the number of DPI (dots per inch) for the extraction of pages from PDF documents may be adjusted as well.
Same goes for the PHP file's installation. It depends on PHP 5.2 or better (so that JSON is included).
Once the PHP file is installed, the path and user for the CLI script must be adjusted (edit the file).
Once the PHP file is installed, the path and user for the CLI script must be set (edit the file).
The CSS file is optional, and it can be adapted.
Finally, ```visudo``` must be run so that the web server user is allowed to execute the CLI script, for example: