Installation and Configuration:
Installation:
- Download Django version 0.96+ http://www.djangoproject.com
- Install Django as per http://www.djangoproject.com/documentation/install/
- unarchive mnemosyne-<version>.tar.gz
- copy settings_template.py to settings.py
- We'll need to configure this in a minute (see below)
- Copy mnemosyne's media files (m_media) to where they're going to be served from (preferably a static media server).
- python manage.py syncdb
Configuration:
First, you'll need to configure Django (especially things like the correct path to the database).
Next, you need to configure Mnemosyne – all mnemosyne specific configuration is in the file settings.py that you copied from settings_template.py.
Paths/etc:
MNEMOSYNE_SETTINGS[ 'path' ] = 'mnemosyne'
Path to wiki relative to root url i.e. http://mysite.com/<path>/
MNEMOSYNE_SETTINGS[ 'media_url'] = MEDIA_URL
Where you're going to serve Mnemosyne's media from
Parser Settings:
MNEMOSYNE_SETTINGS[ 'parser' ] = 'textile'
What parser to use – valid values:
- 'textile' – uses textile markup
- this is most tested & used parser.
- 'docutils' – which uses reStructured Text from Docutils
- '' – Leaving this empty should just spit out plain text.
Macro. Settings:
Macros are small snippets that provide extra functionality.
MNEMOSYNE_SETTINGS[ 'macros' ] = True
(True/False) – Whether to enable macros – these can be quite hard on the server, if you allow too many on one page, so:
MNEMOSYNE_SETTINGS[ 'max_macros_per_page' ] = 2
(integer) – maximum number of macros to execute on any page. This will stop someone plugging in a few hundred of these, and bringing the server to a halt.
MNEMOSYNE_SETTINGS[ 'macrospace' ] = 'Macrospace'
(string) The namespace where information about macros is stored.
MNEMOSYNE_SETTINGS[ 'macro_debug' ] = True
(True/False) Whether to allow macro failures to show (True) or just a generic macro error message (False). NOTE: Having this set to True will kill page execution on a macro error.
Files:
MNEMOSYNE_SETTINGS[ 'allow_files' ] = False
(True/False) – Allow File uploads or not? This is a SECURITY RISK and should NOT be allowed on any public facing websites. For example, people can easily upload javascript etc, and get people to run it. Only trusted users should be allowed to upload files.
MNEMOSYNE_SETTINGS[ 'filepath' ] = '/Users/simon/files/'
(path) – path where files are stored. – Make sure it's present and writable by the webserver…
MNEMOSYNE_SETTINGS[ 'file_url' ] = '/files'
(string) – base URI where the files are served from e.g. http://mysite.com/<FILE_URL>/
MNEMOSYNE_SETTINGS[ 'file_debug' ] = True
(True/False) – shows full file error messages – set to False for a production site. We generally just match this to the Django Debug setting
Tags:
MNEMOSYNE_SETTINGS[ 'tagspace' ] = 'Tag'
(string) – the place where tags 'link to'. CF 'Macrospace' above.
Locking
MNEMOSYNE_SETTINGS[ 'allow_new_pages' ] = True
(True/False) – can non super-users create new pages
Misc.
MNEMOSYNE_SETTINGS[ 'do_bibtex' ] = True
(True/False) Whether to handle bibtex formatted records or not
Statistics:
