Settings

The following settings are available for configuration through your project. All settings are customized by prefixing WIKI_, so for instance URL_CASE_SENSITIVE should be configured as WIKI_URL_CASE_SENSITIVE.

wiki.conf.settings.ACCOUNT_HANDLING = True

Sign up, login and logout views should be accessible

wiki.conf.settings.ACCOUNT_SIGNUP_ALLOWED = True

Signup allowed? If it’s not allowed, logged in superusers can still access the signup page to create new users.

wiki.conf.settings.ANONYMOUS = True

Treat anonymous (non logged in) users as the “other” user group

wiki.conf.settings.ANONYMOUS_CREATE = False

Globally enable create access for anonymous users Defaults to ANONYMOUS_WRITE.

wiki.conf.settings.ANONYMOUS_UPLOAD = False

Default setting to allow anonymous users upload access (used in plugins.attachments and plugins.images).

wiki.conf.settings.ANONYMOUS_WRITE = True

Globally enable write access for anonymous users, if true anonymous users will be treated as the others_write boolean field on models.Article.

wiki.conf.settings.CACHE_TIMEOUT = 600

Seconds of timeout before renewing article cache. Articles are automatically renewed whenever an edit occurs but article content may be generated from other objects that are changed.

wiki.conf.settings.CAN_ADMIN = None

A function returning True/False if a user has permission to create new groups and users for the wiki.

wiki.conf.settings.CAN_ASSIGN = None

A function returning True/False if a user has permission to assign permissions on an article Relevance: changing owner and group membership

wiki.conf.settings.CAN_ASSIGN_OWNER = None

A function returning True/False if the owner of an article has permission to change the group to a user’s own groups Relevance: changing group membership

wiki.conf.settings.CAN_CHANGE_PERMISSIONS = None

A function returning True/False if a user has permission to change read/write access for groups and others

wiki.conf.settings.CAN_DELETE = None

Specifies if a user has access to soft deletion of articles

wiki.conf.settings.CAN_MODERATE = None

A function returning True/False if a user has permission to change moderate, ie. lock articles and permanently delete content.

wiki.conf.settings.CAN_READ = None

A function returning True/False if a user has permission to read contents of an article + plugins Relevance: viewing articles and plugins

wiki.conf.settings.CAN_WRITE = None

A function returning True/False if a user has permission to change contents, ie add new revisions to an article Often, plugins also use this Relevance: editing articles, changing revisions, editing plugins

wiki.conf.settings.CHECK_SLUG_URL_AVAILABLE = True

When True, this blocks new slugs that resolve to non-wiki views, stopping users creating articles that conflict with overlapping URLs from other apps.

wiki.conf.settings.EDITOR = u'wiki.editors.markitup.MarkItUp'

The editor class to use – maybe a 3rd party or your own...? You can always extend the built-in editor and customize it!

wiki.conf.settings.GROUP_MODEL = u'auth.Group'

Choose the Group model to use. Defaults to django’s auth.Group

wiki.conf.settings.LOG_IPS_ANONYMOUS = True

Do we want to log IPs of anonymous users?

wiki.conf.settings.LOG_IPS_USERS = False

Do we want to log IPs of logged in users?

wiki.conf.settings.LOST_AND_FOUND_SLUG = u'lost-and-found'

This slug is used in URLPath if an article has been deleted. The children of the URLPath of that article are moved to lost and found. They keep their permissions and all their content.

wiki.conf.settings.MARKDOWN_HTML_ATTRIBUTES = {u'em': [u'class', u'id'], u'pre': [u'class', u'id'], u'code': [u'class', u'id'], u'figure': [u'class', u'id'], u'h2': [u'class', u'id'], u'h3': [u'class', u'id'], u'h0': [u'class', u'id'], u'h1': [u'class', u'id'], u'h6': [u'class', u'id'], u'h7': [u'class', u'id'], u'h4': [u'class', u'id'], u'h5': [u'class', u'id'], u'table': [u'class', u'id'], u'span': [u'class', u'id'], u'img': [u'class', u'id', u'src', u'alt'], u'ul': [u'class', u'id'], u'tr': [u'class', u'id'], u'tbody': [u'class', u'id'], u'li': [u'class', u'id'], u'hr': [u'class', u'id'], u'th': [u'class', u'id'], u'td': [u'class', u'id'], u'thead': [u'class', u'id'], u'dl': [u'class', u'id'], u'blockquote': [u'class', u'id'], u'acronym': [u'title', u'class', u'id'], u'dd': [u'class', u'id'], u'figcaption': [u'class', u'id'], u'ol': [u'class', u'id'], u'abbr': [u'title', u'class', u'id'], u'br': [u'class', u'id'], u'dt': [u'class', u'id'], u'strong': [u'class', u'id'], u'a': [u'href', u'title', u'class', u'id'], u'b': [u'class', u'id'], u'i': [u'class', u'id'], u'p': [u'class', u'id'], u'div': [u'class', u'id']}

Dictionary of allowed attributes in Markdown article contents.

wiki.conf.settings.MARKDOWN_HTML_STYLES = []

Allowed inline styles in Markdown article contents, default is no styles (empty list)

wiki.conf.settings.MARKDOWN_HTML_WHITELIST = [u'a', u'abbr', u'acronym', u'b', u'blockquote', u'code', u'em', u'i', u'li', u'ol', u'strong', u'ul', u'figure', u'figcaption', u'br', u'hr', u'p', u'div', u'img', u'pre', u'span', u'table', u'thead', u'tbody', u'th', u'tr', u'td', u'dl', u'dt', u'dd', u'h0', u'h1', u'h2', u'h3', u'h4', u'h5', u'h6', u'h7']

List of allowed tags in Markdown article contents.

wiki.conf.settings.MARKDOWN_KWARGS = {u'extension_configs': {u'toc': {u'title': <django.utils.functional.__proxy__ object>}}, u'extensions': [u'footnotes', u'attr_list', u'smart_strong', u'footnotes', u'attr_list', u'def_list', u'tables', u'abbr', u'sane_lists']}

Arguments for the Markdown instance, for instance a list of extensions to use. See: https://pythonhosted.org/Markdown/extensions/index.html

To set a custom title for TOC’s:

WIKI_MARKDOWN_KWARGS = {'extension_configs': {'toc': _('Contents of this article')}}
wiki.conf.settings.MARKDOWN_SANITIZE_HTML = True

Whether to use Bleach or not. It’s not recommended to turn this off unless you know what you’re doing and you don’t want to use the other options.

wiki.conf.settings.MESSAGE_TAG_CSS_CLASS = {'debug': u'alert alert-info', 'info': u'alert alert-info', 'warning': u'alert alert-warning', 'success': u'alert alert-success', 'error': u'alert alert-danger'}

Map from message.tag to bootstrap class name

wiki.conf.settings.REVISIONS_MINUTES_LOOKBACK = 2

Number of minutes for looking up REVISIONS_PER_MINUTES and REVISIONS_PER_MINUTES_ANONYMOUS

wiki.conf.settings.REVISIONS_PER_HOUR = 60

Maximum allowed revisions per hour for any given user or IP

wiki.conf.settings.REVISIONS_PER_HOUR_ANONYMOUS = 10

Maximum allowed revisions per hour for any given user or IP

wiki.conf.settings.REVISIONS_PER_MINUTES = 5

Maximum allowed revisions per minute for any given user or IP

wiki.conf.settings.REVISIONS_PER_MINUTES_ANONYMOUS = 2

Maximum allowed revisions per hour for any given user or IP

wiki.conf.settings.SEARCH_VIEW = u'wiki.views.article.SearchView'

Search view - dotted path denoting where the search view Class is located

wiki.conf.settings.SHOW_MAX_CHILDREN = 20

Maximum amount of children to display in a menu before going “+more” NEVER set this to 0 as it will wrongly inform the user that there are no children and for instance that an article can be safely deleted.

wiki.conf.settings.STORAGE_BACKEND = <django.core.files.storage.DefaultStorage object>

Django Storage backend to use for images, attachments etc.

wiki.conf.settings.URL_CASE_SENSITIVE = False

Should urls be case sensitive?

wiki.conf.settings.URL_CONFIG_CLASS = u'wiki.urls.WikiURLPatterns'

dottedname of class used to construct urlpatterns for wiki.

Default is wiki.urls.WikiURLPatterns. To customize urls or view handlers, you can derive from this.

wiki.conf.settings.USE_BOOTSTRAP_SELECT_WIDGET = True

User Bootstrap’s select widget. Switch off if you’re not using Bootstrap!

wiki.conf.settings.USE_SENDFILE = False

Use Sendfile