Configure Lurker¶

The following sections will cover all possible configuration options to be configured in the `local.py` file.

Note

Make sure you have already copied the local.default.py to local.py. If not please see the installation sections.

Secret Key¶

This option is very important to change at first installation. The secret key is used in several unique and security related aspects and is very important you change and keep secure!

# Generate unique secret key.
SECRET_KEY = 'changeme'

You can generate a new token by running a special command:

$ python manage.py generate_secret_key

Danger

Make sure you change this before start using the application! Not changing could be devastating when your table with passwords leak and for securing cookies, tokens and sessions.

User API Access¶

This option enables the display of a personalized token to the users. Disable if you don’t want to display the tokens to the users on their Account page.

# Enable API tokens for all users
USER_API_KEYS = True

Debug Mode¶

Enable debug mode while developing, will enable several Django related features to investigate some issues.

DEBUG = False

Warning

Enabling debug mode will show users some insights you may want to hide or you don’t want to share. Especially when running in reverse proxy (what you shouldn’t do).

Authentication¶

This part of the configuration is pretty important and can get complicated. It has several options for normal user/pass authentication but even more settings for the Social Authentication implemented in the application.

The authentication options are all suited inside a dict. Bellow is the most basic setup possible.

AUTHENTICATION = {
        'allow_readonly': False,
        'social': {
                'enabled': False,
    },
    'backends': [],
    'options': {},
}

Read Only access¶

You can enable read only access by changing the value of allow_readonly to True. This will allow to only read messages and use global filters.

Mail Forwarding¶

Warning

This feature is not yet completed. Only configuration is known. Some or all functions are not yet implemented!

FORWARDING = {
    # Enable forwarding functionality.
    'enabled': False,

    # Enable automatic forwarding of emails (act as a proxy).
    'automatically': False,

    # Use method for delivering. Choose from 'smtp' / None
    'method': 'smtp',

    # SMTP Smarthost configuration
    'smtp': {
        'host': '127.0.0.1',
        'port': 25,
        'authentication': {
            'enabled': False,
            'username': '',
            'password': '',
        },
        'use_tls': False,
        'use_ssl': False,
        'timeout': None,
        'ssl_keyfile': None,
        'ssl_certfile': None,
    },
}

Automatic Cleanup¶

The lurker listening process can automatically cleanup old messages based on a given timedelta.

Default configuration: .. code-block:: python

CLEANUP_AFTER = timedelta(days=31)

To disable the function: .. code-block:: python

CLEANUP_AFTER = False

Proxy & HTTPS¶

If you have configured your webserver with reverse proxy to the gunicorn process and you want to support HTTPS you may need to change the lines or force the header HTTP-X-Forwarded-Proto to be present by the webserver. Sometimes you want to force this behavior with the following lines:

SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
SECURE_FORCE = True

Database¶

The most important one, and the most expandable one too. Configure your database with the standard Django configuration in the DATABASES field.

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'lurker',
        'USER': 'root',
        'PASSWORD': '',
        'HOST': 'localhost',
        'PORT': '3306',
    }
}

This configuration is exactly the same as the Django one. Default and tested is MySQL, but you may also use some other database engine.