scrolls.configuration module

class scrolls.configuration.Configuration(dependencies)[source]

Bases: object

General settings for Scrolls.

Individual settings are documented as follows;

setting = default_value
type - Explanation.

The settings can be changed in the configuration file, in code, or by passing an ArgParser-like object of commandline arguments to useCommandlineArgs().

All settings:

dry_run = False

bool: Simulate configure() but don’t make filesystem changes.

hashed_password = ''

str: The sha256 hash of the concatenation of your password and the password_secret. You can generate this by running scrolls generate-secrets.

password_secret = 'papyrus'

str: Any string you choose. This is used to encrypt your password. You can generate this by running scrolls generate-secrets.

selectApplications()[source]

Determine which programs to record log events for.

server = '0.0.0.0'

str: URL of the log server.

ticket_secret = 'Herculaneum'

str: Any string you choose. This is used to encrypt the auth cookie. You can generate this by running scrolls generate-secrets.

useCommandlineArgs(args)[source]