From f5609d402a195773ba5c355dd33f812fc76839b7 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Tue, 26 Apr 2016 18:02:45 -0400 Subject: [PATCH] Add backup and ocr backend documentation chapters. --- docs/topics/backups.rst | 16 ++++++++++++++++ docs/topics/index.rst | 2 ++ docs/topics/ocr_backend.rst | 15 +++++++++++++++ 3 files changed, 33 insertions(+) create mode 100644 docs/topics/backups.rst create mode 100644 docs/topics/ocr_backend.rst diff --git a/docs/topics/backups.rst b/docs/topics/backups.rst new file mode 100644 index 0000000000..83077433ee --- /dev/null +++ b/docs/topics/backups.rst @@ -0,0 +1,16 @@ +======= +Backups +======= + +To backup your install of Mayan EDMS just copy the actual document files and +the database content. If you are using the default storage backend, the +document files should be found in ``mayan/media/document_storage/``. + +To dump the content of your database manager refer to the documentation chapter +regarding database data "dumping". + +Example: + + - Postgresl: http://www.postgresql.org/docs/current/static/backup.html + - MySQL: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html + - SQLite: Just copy the file ``mayan/media/db.sqlite3`` diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 3b780c58e2..5f892d160b 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -15,9 +15,11 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: checkouts versioning signatures + ocr_backend indexes smart_links tags mailing file_storage + backups screenshots diff --git a/docs/topics/ocr_backend.rst b/docs/topics/ocr_backend.rst new file mode 100644 index 0000000000..ab0de3c835 --- /dev/null +++ b/docs/topics/ocr_backend.rst @@ -0,0 +1,15 @@ +=========== +OCR backend +=========== + +Mayan EDMS ships an OCR backend that uses the FLOSS engine Tesseract, but it can +use other engines. To support other engines a wrapper that subclasess the +``OCRBackendBase`` class defined in mayan/apps/ocr/classes. This subclass should +expose the ``execute`` method. For an example of how the Tesseract backend +is implemented take a look at the file ``mayan/apps/ocr/backends/tesseract.py`` + +Once you create you own backend, in your local.py settings add the option +OCR_BACKEND and point it to your new OCR backend class path. + +The default value of OCR_BACKEND is ``"ocr.backends.tesseract.Tesseract"`` +