Documentation updates
This commit is contained in:
Roberto Rosario
+10
-4
@@ -44,12 +44,18 @@ Suggestions
|
|||||||
Translations
|
Translations
|
||||||
------------
|
------------
|
||||||
* Portuguese
|
* Portuguese
|
||||||
* Emerson Soares (http://emersonsoares.com)
|
|
||||||
* Renata Oliveira (https://twitter.com/#!/rnataoliveira)
|
- Emerson Soares (http://emersonsoares.com)
|
||||||
|
- Renata Oliveira (https://twitter.com/#!/rnataoliveira)
|
||||||
|
|
||||||
* Russian
|
* Russian
|
||||||
* Сергей Глита [Sergey Glita] (s.v.glita@gmail.com)
|
|
||||||
|
- Сергей Глита [Sergey Glita] (s.v.glita@gmail.com)
|
||||||
|
|
||||||
* Italian
|
* Italian
|
||||||
* SeeOpen.IT (Numero Verde: 800.910.125, E-mail: sales@seeopen.it)
|
|
||||||
|
- SeeOpen.IT (Numero Verde: 800.910.125, E-mail: sales@seeopen.it)
|
||||||
|
|
||||||
|
|
||||||
Remote access for debugging
|
Remote access for debugging
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|||||||
+64
-67
@@ -5,26 +5,24 @@ FAQ
|
|||||||
Frequently asked questions and solutions
|
Frequently asked questions and solutions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
_mysql_exceptions.OperationalError: (1267, "Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (utf8_general_ci,COERCIBLE) for operation '='")
|
_mysql_exceptions.OperationalError: (1267, "Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (utf8_general_ci,COERCIBLE) for operation '='")
|
||||||
------------------------------------------------------------------------------------------------------------------------------------------------------
|
------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
* Solution::
|
* Solution::
|
||||||
|
|
||||||
$ manage.py shell
|
$ manage.py shell
|
||||||
>>> from django.db import connection
|
>>> from django.db import connection
|
||||||
>>> cursor = connection.cursor()
|
>>> cursor = connection.cursor()
|
||||||
>>> cursor.execute('SHOW TABLES')
|
>>> cursor.execute('SHOW TABLES')
|
||||||
>>> results=[]
|
>>> results=[]
|
||||||
>>> for row in cursor.fetchall(): results.append(row)
|
>>> for row in cursor.fetchall(): results.append(row)
|
||||||
>>> for row in results: cursor.execute('ALTER TABLE %s CONVERT TO CHARACTER SET utf8 COLLATE utf8_general_ci;' % (row[0]))
|
>>> for row in results: cursor.execute('ALTER TABLE %s CONVERT TO CHARACTER SET utf8 COLLATE utf8_general_ci;' % (row[0]))
|
||||||
|
|
||||||
|
|
||||||
* References:
|
* References:
|
||||||
|
|
||||||
- http://www.djangoshmango.com/?p=99
|
- http://www.djangoshmango.com/?p=99
|
||||||
- http://stackoverflow.com/questions/1073295/django-character-set-with-mysql-weirdness
|
- http://stackoverflow.com/questions/1073295/django-character-set-with-mysql-weirdness
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row 1
|
Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row 1
|
||||||
@@ -32,102 +30,101 @@ Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row
|
|||||||
|
|
||||||
When using ``MySQL`` and doing OCR on languages other than English
|
When using ``MySQL`` and doing OCR on languages other than English
|
||||||
|
|
||||||
* Solution:
|
* Solution:
|
||||||
|
|
||||||
- Use utf-8 collation on MySQL server, or at least in table 'documents_documentpage', 'content' field
|
- Use utf-8 collation on MySQL server, or at least in table 'documents_documentpage', 'content' field
|
||||||
- Ref: 1- http://groups.google.com/group/django-users/browse_thread/thread/429447086fca6412
|
- Ref: 1- http://groups.google.com/group/django-users/browse_thread/thread/429447086fca6412
|
||||||
- Ref: 2- http://markmail.org/message/bqajx2utvmtriixi
|
- Ref: 2- http://markmail.org/message/bqajx2utvmtriixi
|
||||||
|
|
||||||
|
|
||||||
File system links not showing when serving content with ``Samba``
|
File system links not showing when serving content with ``Samba``
|
||||||
-----------------------------------------------------------------
|
-----------------------------------------------------------------
|
||||||
|
|
||||||
* Solution:
|
* Solution:
|
||||||
|
|
||||||
- Disable unix extensions in the [global] section and enable wide links for the file serving share
|
- Disable unix extensions in the [global] section and enable wide links for the file serving share
|
||||||
|
- Example::
|
||||||
- Example::
|
|
||||||
|
|
||||||
[global]
|
[global]
|
||||||
unix extensions = no
|
unix extensions = no
|
||||||
|
|
||||||
...
|
...
|
||||||
|
|
||||||
[digitalizacion]
|
[digitalizacion]
|
||||||
path = /var/local/mayan
|
path = /var/local/mayan
|
||||||
guest ok = yes
|
guest ok = yes
|
||||||
read only = yes
|
read only = yes
|
||||||
wide links = yes
|
wide links = yes
|
||||||
follow symlinks = yes
|
follow symlinks = yes
|
||||||
|
|
||||||
|
|
||||||
- Ref: 1- http://www.samba.org/samba/docs/man/manpages-3/smb.conf.5.html
|
- Ref: 1- http://www.samba.org/samba/docs/man/manpages-3/smb.conf.5.html
|
||||||
|
|
||||||
|
|
||||||
How to store documents outside of **Mayan EDMS's** path
|
How to store documents outside of **Mayan EDMS's** path
|
||||||
-------------------------------------------------------
|
-------------------------------------------------------
|
||||||
|
|
||||||
* Sub class Django's ``FileSystemStorage`` class:
|
* Sub class Django's ``FileSystemStorage`` class:
|
||||||
|
|
||||||
- Create a file called ``customstorage.py``::
|
- Create a file called ``customstorage.py``::
|
||||||
|
|
||||||
from django.core.files.storage import FileSystemStorage
|
from django.core.files.storage import FileSystemStorage
|
||||||
|
|
||||||
class CustomStorage(FileSystemStorage):
|
class CustomStorage(FileSystemStorage):
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
super(CustomStorage, self).__init__(*args, **kwargs)
|
super(CustomStorage, self).__init__(*args, **kwargs)
|
||||||
self.location='/new/path/to/documents/'
|
self.location='/new/path/to/documents/'
|
||||||
self.base_url='document_storage'
|
self.base_url='document_storage'
|
||||||
|
|
||||||
- In the ``settings.py`` add::
|
- In the ``settings.py`` add::
|
||||||
|
|
||||||
from customstorage import CustomStorage
|
from customstorage import CustomStorage
|
||||||
DOCUMENTS_STORAGE_BACKEND = CustomStorage
|
DOCUMENTS_STORAGE_BACKEND = CustomStorage
|
||||||
|
|
||||||
|
|
||||||
How to enable the ``GridFS`` storage backend
|
How to enable the ``GridFS`` storage backend
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
* Solution:
|
* Solution:
|
||||||
|
|
||||||
- Add the following lines to ``settings.py``::
|
- Add the following lines to ``settings.py``::
|
||||||
|
|
||||||
from storage.backends.gridfsstorage import GridFSStorage
|
from storage.backends.gridfsstorage import GridFSStorage
|
||||||
DOCUMENTS_STORAGE_BACKEND = GridFSStorage
|
DOCUMENTS_STORAGE_BACKEND = GridFSStorage
|
||||||
|
- Filesystem metadata indexing will not work with this storage backend as
|
||||||
- Filesystem metadata indexing will not work with this storage backend as
|
the files are inside a ``MongoDB`` database and can't be linked (at least for now)
|
||||||
the files are inside a ``MongoDB`` database and can't be linked (at least for now)
|
|
||||||
|
|
||||||
|
|
||||||
Site search is slow
|
Site search is slow
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
* Add indexes to the following fields:
|
* Add indexes to the following fields:
|
||||||
|
|
||||||
- ``documents_document`` - description, recommended size: 160
|
- ``documents_document`` - description, recommended size: 160
|
||||||
- ``documents_documentpage`` - content, recommended size: 3000
|
- ``documents_documentpage`` - content, recommended size: 3000
|
||||||
|
|
||||||
|
|
||||||
How to enable x-sendile support for ``Apache``
|
How to enable x-sendile support for ``Apache``
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
* If using Ubuntu execute the following::
|
* If using Ubuntu execute the following::
|
||||||
|
|
||||||
$ sudo apt-get install libapache2-mod-xsendfile
|
$ sudo apt-get install libapache2-mod-xsendfile
|
||||||
|
|
||||||
* Add the following line to your ``settings.py`` file::
|
* Add the following line to your ``settings.py`` file::
|
||||||
|
|
||||||
SENDFILE_BACKEND = 'sendfile.backends.xsendfile'
|
SENDFILE_BACKEND = 'sendfile.backends.xsendfile'
|
||||||
|
|
||||||
* On your apache configuration file add::
|
* On your apache configuration file add::
|
||||||
|
|
||||||
XSendFile on
|
XSendFile on
|
||||||
XSendFileAllowAbove on
|
XSendFileAllowAbove on
|
||||||
|
|
||||||
|
|
||||||
The included version of ``unoconv`` in my distribution is too old
|
The included version of ``unoconv`` in my distribution is too old
|
||||||
-------------------------------------------------------------
|
-------------------------------------------------------------
|
||||||
|
|
||||||
* Only the file 'unoconv' file from https://github.com/dagwieers/unoconv is needed.
|
* Only the file 'unoconv' file from https://github.com/dagwieers/unoconv is needed.
|
||||||
Put it in a user designated directory for binaries such as /usr/local/bin and
|
Put it in a user designated directory for binaries such as /usr/local/bin and
|
||||||
setup Mayan's configuration option in your settings_local.py file like this::
|
setup Mayan's configuration option in your settings_local.py file like this::
|
||||||
|
|
||||||
CONVERTER_UNOCONV_PATH = '/usr/local/bin/unoconv'
|
CONVERTER_UNOCONV_PATH = '/usr/local/bin/unoconv'
|
||||||
|
|||||||
+3
-3
@@ -2,16 +2,16 @@
|
|||||||
Overview
|
Overview
|
||||||
========
|
========
|
||||||
|
|
||||||
Open source, Django_ based document manager with custom metadata indexing, file serving integration and OCR_ capabilities.
|
Open source, Django_ based document manager with custom metadata indexing, file serving integration, OCR_ capabilities, document versioning and digital signature verification.
|
||||||
|
|
||||||
.. _Django: http://www.djangoproject.com/
|
.. _Django: http://www.djangoproject.com/
|
||||||
|
|
||||||
|
|
||||||
:Website: http://bit.ly/mayan-edms
|
:Website: http://www.mayan-edms.com
|
||||||
:Source: http://github.com/rosarior/mayan
|
:Source: http://github.com/rosarior/mayan
|
||||||
:Video: http://bit.ly/pADNXv
|
:Video: http://bit.ly/pADNXv
|
||||||
:Issue tracker: http://github.com/rosarior/mayan/issues
|
:Issue tracker: http://github.com/rosarior/mayan/issues
|
||||||
|
:Mailing list: http://groups.google.com/group/mayan-edms
|
||||||
|
|
||||||
**Mayan EDMS** started as a simple project whose only requirement was the storage of PDF files, from there it has grown into a complete electronic document management solution.
|
**Mayan EDMS** started as a simple project whose only requirement was the storage of PDF files, from there it has grown into a complete electronic document management solution.
|
||||||
**Mayan EDMS** can optimize an organization's bulk upload, storage and retrieval or documents.
|
**Mayan EDMS** can optimize an organization's bulk upload, storage and retrieval or documents.
|
||||||
|
|||||||
+10
-8
@@ -84,7 +84,7 @@ the download of several documents in a single compressed file.
|
|||||||
Customizable GPG home directory
|
Customizable GPG home directory
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Addition of the SIGNATURES_GPG_HOME configuration option to let
|
Addition of the SIGNATURES_GPG_HOME configuration option to let
|
||||||
administrators set Mayan EDMS's GPG instance home directory, used to
|
administrators set **Mayan EDMS**'s GPG instance home directory, used to
|
||||||
store keyrings and other GPG configuration files.
|
store keyrings and other GPG configuration files.
|
||||||
|
|
||||||
Upgrading
|
Upgrading
|
||||||
@@ -99,15 +99,16 @@ Upgrading
|
|||||||
|
|
||||||
When the following message appears
|
When the following message appears
|
||||||
|
|
||||||
``The following content types are stale and need to be deleted:
|
.. epigraph::
|
||||||
|
The following content types are stale and need to be deleted:
|
||||||
|
|
||||||
permissions | permission
|
permissions | permission
|
||||||
|
|
||||||
Any objects related to these content types by a foreign key will also
|
Any objects related to these content types by a foreign key will also
|
||||||
be deleted. Are you sure you want to delete these content types?
|
be deleted. Are you sure you want to delete these content types?
|
||||||
If you're unsure, answer 'no'.
|
If you're unsure, answer 'no'.
|
||||||
|
|
||||||
Type 'yes' to continue, or 'no' to cancel:``
|
Type 'yes' to continue, or 'no' to cancel:
|
||||||
|
|
||||||
Types ``yes`` and press **Enter**
|
Types ``yes`` and press **Enter**
|
||||||
|
|
||||||
@@ -138,4 +139,5 @@ Stuff removed
|
|||||||
* Support for Celery and Sentry has been drop
|
* Support for Celery and Sentry has been drop
|
||||||
for now.
|
for now.
|
||||||
* Removed the 'db_index' argument from Text fields definition and
|
* Removed the 'db_index' argument from Text fields definition and
|
||||||
migrations as it was causing error messages for MySQL users.
|
migrations as it was causing error messages for MySQL users, thanks to
|
||||||
|
Сергей Глита for reporting this one.
|
||||||
|
|||||||
Reference in New Issue
Block a user