Config¶

The config is the main way of changing the behaviour of BlueWeather.

Example Config

commands:
  restart: ''
  shutdown: ''
  stop: ''
debug: true
extensions:
  disabled: []
  settings:
    dummySettings:
    _version: 1
    description: Yeet My Feet
  weather_driver: dummyWeather
secret_key: fe#c_@_&%0v4gvv0pivtj+b*!aafttzlo6v7&6%9v^+7^dmgx0
web:
  api_keys:
  - key: 42237522-c7027c31-f90f5e34-b513c5a6
    name: default
  databases:
    default:
    engine: sqlite3
    path: db.sqlite3
  password_validation:
    - UserAttributeSimilarityValidator
    - MinimumLengthValidator
    - CommonPasswordValidator
    - NumericPasswordValidator
  template_globals:
  title: BlueWeather

Secret Key¶

secret_key¶

Type:	str

The secret key used by django. This is auto-generated and should not be shared with anyone.

Debug¶

debug

Type:	bool
Default:	false

Should the server start in debug mode

Note

This should be set to false in almost all circumstances.

Time Zone¶

time_zone¶

Type:	str

The time zone that your server is located in.

Commands¶

commands

Type:	dict

A list of system commands that can control the server

{
    'restart': 'command to restart the server',
    'shutdown': 'command to shutdown the computer',
    'stop': 'command to stop the server'
}

Web¶

Static URL¶

web.static_url¶

Type:	str
Default:	static

the endpoint of the static url.

Databases¶

web.databases¶: All the databases. I’m not entirely sure why I would need multiple databases, but the support is there.

Todo

Figure out what’s going on.

Password Validation¶

web.password_validation¶

Type:	list

A list of django password validators used to validate passwords.

Default:	[ "userAttributeSimilarityValidator", "MinimumLengthValidator", "CommonPasswordValidator", "NumericPasswordValidator" ]

Allowed Hosts¶

web.allowed_hosts¶

Type:	list

A list of hosts that the server will listen on.

Template Globals¶

web.template_globals¶

Type:	dict

Global variables to be inserted into templates.

Api Keys¶

web.api_keys¶

Type:	list

A list of API keys and their permissions

[
    {
        'key': 'key-value',
        'name': 'name of the key',
        'permissions': [
            'permission'
        ]
    }
]

Extensions¶

Weather Driver¶

extensions.weather_driver¶

Type:	str
Default:	dummyWeather

The driver to use to get the weather.

Disabled¶

extensions.disabled¶

Type:	list

A list of disabled plugins

Settings¶

extensions.settings¶

Type:	dict

The settings for each plugin.