Use config.py to configure the following parameters. By default it will use SQLLITE DB, and bootstrap's default theme:
.. cssclass:: table-bordered table-hover
| Key | Description | Mandatory |
|---|---|---|
| SQLALCHEMY_DATABASE_URI | DB connection string (flask-sqlalchemy) | Cond. |
| MONGODB_SETTINGS | DB connection string (flask-mongoengine) | Cond. |
|
|
Yes |
| AUTH_USER_REGISTRATION = True|False | Set to True to enable user self registration | No |
| AUTH_USER_REGISTRATION_ROLE | Set role name, to be assign when a user registers himself. This role must already exist. Mandatory when using user registration | Cond. |
| AUTH_LDAP_SERVER | define your ldap server when AUTH_TYPE=2 example: AUTH_TYPE = 2 AUTH_LDAP_SERVER = "ldap://ldapserver.new" |
Cond. |
| AUTH_LDAP_BIND_USER | Define the DN for the user that will be used for the initial LDAP BIND. This is necessary for OpenLDAP and can be used on MSFT AD. AUTH_LDAP_BIND_USER = "cn=queryuser,dc=example,dc=com" |
No |
| AUTH_LDAP_BIND_PASSWORD | Define password for the bind user. | No |
| AUTH_LDAP_TLS_DEMAND | Demands TLS peer certificate checking (Bool) | No |
| AUTH_LDAP_TLS_CACERTDIR | CA Certificate directory to check peer certificate | No |
| AUTH_LDAP_TLS_CACERTFILE | CA Certificate file to check peer certificate | No |
| AUTH_LDAP_TLS_CERTFILE | Certificate file for client auth use with AUTH_LDAP_TLS_KEYFILE | No |
| AUTH_LDAP_TLS_KEYFILE | Certificate key file for client aut | No |
| AUTH_LDAP_SEARCH | Use search with self user registration or when using AUTH_LDAP_BIND_USER. AUTH_LDAP_SERVER = "ldap://ldapserver.new" AUTH_LDAP_SEARCH = "ou=people,dc=example" |
No |
| AUTH_LDAP_SEARCH_FILTER | Filter or limit allowable users from the LDAP server, e.g., only the people on your team. AUTH_LDAP_SEARCH_FILTER = "(memberOf=cn=group name,OU=type,dc=ex ,cn=com)" |
No |
| AUTH_LDAP_UID_FIELD | if doing an indirect bind to ldap, this is the field that matches the username when searching for the account to bind to. example: AUTH_TYPE = 2 AUTH_LDAP_SERVER = "ldap://ldapserver.new" AUTH_LDAP_SEARCH = "ou=people,dc=example" AUTH_LDAP_UID_FIELD = "uid" |
No |
| AUTH_LDAP_FIRSTNAME_FIELD | sets the field in the ldap directory that stores the user's first name. This field is used to propagate user's first name into the User database. Default is "givenName". example: AUTH_TYPE = 2 AUTH_LDAP_SERVER = "ldap://ldapserver.new" AUTH_LDAP_SEARCH = "ou=people,dc=example" AUTH_LDAP_FIRSTNAME_FIELD = "givenName" |
No |
| AUTH_LDAP_LASTNAME_FIELD | sets the field in the ldap directory that stores the user's last name. This field is used to propagate user's last name into the User database. Default is "sn". example: AUTH_TYPE = 2 AUTH_LDAP_SERVER = "ldap://ldapserver.new" AUTH_LDAP_SEARCH = "ou=people,dc=example" AUTH_LDAP_LASTNAME_FIELD = "sn" |
No |
| AUTH_LDAP_EMAIL_FIELD | sets the field in the ldap directory that stores the user's email address. This field is used to propagate user's email address into the User database. Default is "mail". example: AUTH_TYPE = 2 AUTH_LDAP_SERVER = "ldap://ldapserver.new" AUTH_LDAP_SEARCH = "ou=people,dc=example" AUTH_LDAP_EMAIL_FIELD = "mail" |
No |
| AUTH_LDAP_ALLOW_SELF_SIGNED | Allow LDAP authentication to use self signed certificates (LDAPS) | No |
| AUTH_LDAP_APPEND_DOMAIN | Append a domain to all logins. No need to use john@domain.local. Set it like: AUTH_LDAP_APPEND_DOMAIN = 'domain.local' And the user can login using just 'john' |
No |
| AUTH_LDAP_USERNAME_FORMAT | It converts username to specific format for LDAP authentications. For example, username = "userexample" AUTH_LDAP_USERNAME_FORMAT="format-%s". It authenticates with "format-userexample". |
No |
| AUTH_ROLE_ADMIN | Configure the name of the admin role. | No |
| AUTH_ROLE_PUBLIC | Special Role that holds the public permissions, no authentication needed. | No |
| APP_NAME | The name of your application. | No |
| APP_THEME | Various themes for you to choose from (bootwatch). | No |
| APP_ICON | path of your application icons will be shown on the left side of the menu | No |
| ADDON_MANAGERS | A list of addon manager's classes Take a look at addon chapter on docs. | No |
| UPLOAD_FOLDER | Files upload folder. Mandatory for file uploads. | No |
| FILE_ALLOWED_EXTENSIONS | Tuple with allower extensions. FILE_ALLOWED_EXTENSIONS = ('txt','doc') | No |
| IMG_UPLOAD_FOLDER | Image upload folder. Mandatory for image uploads. | No |
| IMG_UPLOAD_URL | Image relative URL. Mandatory for image uploads. | No |
| IMG_SIZE | tuple to define default image resize. (width, height, True|False). | No |
| BABEL_DEFAULT_LOCALE | Babel's default language. | No |
| LANGUAGES | A dictionary mapping the existing languages with the countries name and flag | No |
| FAB_API_SHOW_STACKTRACE | Sends api stack trace on uncaught exceptions. (Boolean) | No |
| FAB_API_MAX_PAGE_SIZE | Sets a limit for FAB Model Api page size | No |
| FAB_API_SWAGGER_UI | Enables a Swagger UI view (Boolean) | No |
My favorite way, and the one I advise if you are building a medium to large size application is to place all your configuration keys on a config.py file
Next you only have to import them to the Flask app object, like this
app = Flask(__name__)
app.config.from_object('config')
Take a look at the skeleton config.py