Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 4.9 KB

CONFIGURATION.md

File metadata and controls

81 lines (54 loc) · 4.9 KB
Raw

Cloud-Session configuration

Database connection, metrics, mail server and token buckets can be configured using a properties file. The application will look for a file called cloudsession.properties in the home directory of the user that started the tomcat at startup.

If changes are made to the configuration file, the server will need to be restarted to put these into effect.

Database configuration

To configure the database connection use the following configuration property:

  • Connection url: database.url. Defaults to: mysql+mysqldb://cloudsession:cloudsession@localhost:3306/cloudsession

To use anything but mysql, the python connector library will need to be installed and you will have to look up to correct connection url on SQLAlchemy documentation.

Mail server

By default mails will be sent from [email protected] using a smtp server on localhost with a non encrypted connection on port 25. For any changes use the following configurations.

  • Send mail from a given address: mail.from. Defaults to: [email protected]
  • Set mailserver host: mail.host. Defaults to: localhost
  • Enable authentication on the mailserver: mail.authenticated, true/false. Defaults to: false
  • Set username for authentication on the mailserver: mail.user. Required when mail.authenticated is set to true
  • Set password for authentication on the mailserver: mail.password. Required when mail.authenticated is set to true
  • Enable tls encryption on the connection: mail.tls, true/false. Defaults to: false. Setting this to true will change the default port to 587.
  • Change the connection port (only available when tls is enabled): mail.port. Defaults to 587
  • Enable ssl encryption on the connection (only available when tls is enabled): mail.ssl, true/false. Defaults to: false

Token buckets

The token buckets need to be listed and then configured one by one.

The list of bucket types is put in bucket.types, separated by ', '.

Then each bucket needs some configuration, the size and input speed is required, while input frequency defaults to once a second. In each of these configurations, replace the [TYPE] by the string previously put in the bucket.types parameter.

The bucket size is put in bucket.[TYPE].size and the input speed (amount of tokens that are added based on the input frequency) in bucket.[TYPE].input.

If you want another frequency then once a second, it can be configured in bucket.[TYPE].freq. The value is an amount of milliseconds that elapse between each time that new tokens are added into the bucket.

Because of a limitation in the database, the timestamp of the last token change is limited to second resolution.

Each of the bucket configurations has to be a positive number of no more then 2,000,000,000 (about 24 days), and cannot have decimal places.

Wrong password, email confirm and password reset policies

Token buckets are used to configure rate limitting on logins with wrong passwords, email confirm requests and password reset requests.

To change the default values for these limits use the configuration as described in the token buckets section.

  • Wrong password (use type: failed-password): 1 token every 120000ms (2 minutes) with a bucket size of 3.
  • Email confirm requests (use type: email-confirm): 1 token every 1800000ms (30 minutes) with a bucket size of 2.
  • Password reset requests (use type: password-reset): 1 token every 1800000ms (30 minutes) with a bucket size of 2.

Email template configuration

The email templates, created in Mustache, have to be put in a specific directory structure inside the template subdirectory of the user home directory.

Inside this base directory, following directory structure is required for the system to find the templates:

locale - type - server

Example (where blocklyprop is the server identifier for demonstration purposes):

  • en
    • confirm
      • blocklyprop
    • reset
      • blocklyprop
  • es
    • confirm
      • blocklyprop
    • reset
      • blocklyprop

In these directories a header.mustache and plain.mustache file are required. They will respectively contain the template for the email header and the plaintext html body. If you wish you can add a rich.mustache to add a html version to your sent emails.

The available placeholders are:

  • {{email}} This will be replaced with the email address of the user
  • {{locale}} This will be replaced with the locale of the user (will be the same as the name of the directory)
  • {{screenname}} This will be replaced with the screenname of the user
  • {{token}} This will be replaced with the token the user has to use for the specific operation

For more information about writing templates: see the freemarker template Author's guide.