Contents
Kotti is configured using an INI configuration file. The Installation section explains how to get hold of a sample configuration file. The [app:main] section in it might look like this:
[app:main]
use = egg:Kotti
pyramid.reload_templates = true
pyramid.debug_authorization = false
pyramid.debug_notfound = false
pyramid.debug_routematch = false
pyramid.debug_templates = true
pyramid.default_locale_name = en
pyramid.includes = pyramid_debugtoolbar
pyramid_tm
mail.default_sender = yourname@yourhost
sqlalchemy.url = sqlite:///%(here)s/Kotti.db
kotti.site_title = Kotti
kotti.secret = changethis1
Various aspects of your site can be changed right here.
This table provides an overview of available settings. All these settings must go into the [app:main] section of your Paste Deploy configuration file.
| Setting | Description |
|---|---|
| kotti.site_title | The title of your site |
| kotti.secret | Secret token used for the initial admin password |
| kotti.secret2 | Secret token used for email password reset token |
| sqlalchemy.url | SQLAlchemy database URL |
| mail.default_sender | Sender address for outgoing email |
| mail.host | Email host to send from |
| pyramid.includes | List of Python configuration hooks |
| kotti.available_types | List of active content types |
| kotti.base_includes | List of base Python configuration hooks |
| kotti.configurators | List of advanced functions for config |
| kotti.root_factory | Override Kotti’s default Pyramid root factory |
| kotti.populators | List of functions to fill initial database |
| kotti.asset_overrides | Override Kotti’s templates, CSS files and images. |
| kotti.templates.api | Override api used by all templates |
| kotti.authn_policy_factory | Component used for authentication |
| kotti.authz_policy_factory | Component used for authorization |
| kotti.session_factory | Component used for sessions |
| kotti.date_format | Date format to use, default: medium |
| kotti.datetime_format | Datetime format to use, default: medium |
| kotti.time_format | Time format to use, default: medium |
| pyramid.default_locale_name | Set the user interface language, default en |
Only the settings in bold letters required. The rest has defaults.
Do take a look at the required settings (in bold) and adjust them in your site’s configuration. A few of the settings are less important, and sometimes only used by developers, not integrators.
The value of kotti.secret will define the initial password of the admin user. Thus, if you define kotti.secret = mysecret, the admin password will be mysecret. Log in and change the password at any time through the web interface.
The kotti.secret token is also used for signing browser session cookies. The kotti.secret2 token is used for signing the password reset token.
Here’s an example:
kotti.secret = myadminspassword
kotti.secret2 = $2a$12$VVpW/i1MA2wUUIUHwY6v8O
Note
Do not use these values in your site
In your settings file, set kotti.override_assets to a list of asset specifications. This allows you to set up a directory in your package that will mirror Kotti’s own and that allows you to override Kotti’s templates, CSS files and images on a case by case basis.
As an example, image that we wanted to override Kotti’s master layout template. Inside the Kotti source, the layout template is at kotti/templates/view/master.pt. To override this, we would add a directory to our own package called kotti-overrides and therein put our own version of the template so that the full path to our own custom template is mypackage/kotti-overrides/templates/view/master.pt.
We can then register our kotti-overrides directory by use of the kotti.asset_overrides setting, like so:
kotti.asset_overrides = mypackage:kotti-overrides/
Add-ons will usually include in their installation instructions which settings one should modify to activate them. Configuration settings that are used to activate add-ons are:
pyramid.includes defines a list of hooks that will be called when your Kotti app starts up. This gives the opportunity to third party packages to add registrations to the Pyramid Configurator API in order to configure views and more.
Here’s an example. Let’s install the kotti_twitter extension and add a Twitter profile widget to the right column of all pages. First we install the package from PyPI:
bin/pip install kotti_twitter
Then we activate the add-on in our site by editing the pyramid.includes setting in the [app:main] section of our INI file. (If a line with pyramid.includes does not exist, add it.)
pyramid.includes = kotti_twitter.include_profile_widget
kotti_twitter also asks us to configure the Twitter widget itself, so we add some more lines right where we were:
kotti_twitter.profile_widget.user = dnouri
kotti_twitter.profile_widget.loop = true
The order in which the includes are listed matters. For example, when you add two slots on the right hand side, the order in which you list them in pyramid.includes will control the order in which they will appear. As an example, here’s a configuration with which the search widget will be displayed above the profile widget:
pyramid.includes =
kotti_twitter.include_search_widget
kotti_twitter.include_profile_widget
Read more about including packages using ‘pyramid.includes’ in the Pyramid documentation.
The kotti.available_types setting defines the list of content types available. The default configuration here is:
kotti.available_types = kotti.resources.Document kotti.resources.File
An example that removes File and adds two content types:
kotti.available_types =
kotti.resources.Document
kotti_calendar.resources.Calendar
kotti_calendar.resources.Event
The default configuration here is:
kotti.populators = kotti.populate.populate
Populators are functions with no arguments that get called on system startup. They may then make automatic changes to the database (before calling transaction.commit()).
By default, Kotti will display its user interface in English. The default configuration is:
pyramid.default_locale_name = en
You can configure Kotti to serve a German user interface by saying:
pyramid.default_locale_name = de_DE
The list of available languages is here.
You can override the authentication and authorization policy that Kotti uses. By default, Kotti uses these factories:
kotti.authn_policy_factory = kotti.authtkt_factory
kotti.authz_policy_factory = kotti.acl_factory
These settings correspond to pyramid.authentication.AuthTktAuthenticationPolicy and pyramid.authorization.ACLAuthorizationPolicy being used.