Grape configuration

For the configuration of Grape we will use grape configure.

By default it will only ask you for values that have not been set yet. You can force all available dialogues by setting the flag --force-reconfigure.

Note: If you are not sure what an option means you can just enter ? and return, for almost all options this will return a short help text.

Basic configuration

Section global

  • External HTTP Port: Set this to a different value if you cannot expose port 80 for http. Mostly for testing.
  • External HTTPS Port: Set this to a different value if you cannot expose port 443 for https. Mostly for testing.
  • HTTP proxy server: If the network the Grape server is in can only reach other websites through a proxy you can enter it here. Expected format: http://USER:PASS@HOST:PORT or http://HOST@PORT (optional)
  • HTTPS proxy server: Same as the option above this one. (optional)
  • Hostnames to exclude from proxy: Comma-separated list of hosts that must be reachable by the Grape instance but cannot be reached through the proxy. Valid hostname format: [schema://]fqdn or ip_address[:port],[schema://]fqdn or ip_address[:port],...

Section proxy

  • Do you want to use a list of subdomains instead of a wildcard: Say yes here if you want to specify a list of subdomains instead of using e.g. *.grape.example.com.
    • Please enter a comma-separated list of subdomains you want to use: a comma separated list of valid subdomain names for you instance. Do not add the base domain name, e.g. use team-0 for team-0.grape.example.com

Section grape

  • Hostname of your Grape instance: This will be the domain name of your Grape landing page.
  • Alternative hostname of your Grape instance: Set this if your instance will be reachable trough a different domain, too. You will most likely not need that.
  • Email Address of the administrative user: The email address of the Grape admin user that get’s created at provisioning time.
  • Initial password of the administrative user: This is the password that will be set on the first provisioning of Grape. Changing it later will not change an already set password.
  • Email address Grape sends mails from: Grape needs to be able to send emails to it’s users, this address will be used as a ‘From:’ address.
  • Support email address: The email address shown as a support email address on the page. It is safe to leave the default set.
  • Mailserver address to use: The address of the mailserver to use, can be either an IPv6 address or a domain name.
  • Mailserver port: The port to use on the server entered above
  • Mail server needs TLS: Set this to “yes” if your server requires TLS encryption enabled to send mails.
  • Username for SMTP authentification: If you need to authenticate with your mail server you can set the username here. (optional)
  • Password for SMTP authentification: If you need to authenticate with your mail server you can set the password here. (optional)
  • Enable push notifications: Say “no” here if you want to disable push notifications to mobile clients. You most likely want to keep this enabled.
    • Enable Apple push notifications: Say “no” to disable push notifications to iOS devices.
    • Enable Google push notifications: Say “no” to disable push notifications to Android/google devices.
    • Enable Microsoft push notifications: Say “no” to disable push notifications to Windows Phone/Mobile devices.
  • Do you want to use your own elasticsearch instance/cluster [n]: Experimental feature, enables using another elasticsearch instance/cluster than the bundled one. Support for ES versions is limited, and lots of customization needed at this point. Do not use this option unless when working together with the Grape team.
  • Do you want to use your own redis instance [n]: Experimental feature, enables using another redis instance/cluster than the bundled one. Versions 3.0 to 3.4 supported. Do not use this option unless when working together with the Grape team.
  • Do you want to use your own PostgreSQL instance [n]: Experimental feature, enables using another postgresql instance/cluster than the bundled one. Versions 9.4 to 10.0 supported. Do not use this option unless when working together with the Grape team.
  • Do you want to use a custom SSL cerificate authority: Answer “yes” here if you need the certificate of a custom root CA installed. (optional)
    • Please enter the path to the file containing the custom root CA: The path to the root CA pem certificate file
    • Please enter the path to the file containing the custom intermediate CA: The path to the intermediate CA pem certificate file
  • Enter a custom session cookie age: The time in seconds after which a cookie will automatically become invalid. Default: 86400 (1 day)
  • Enable MX record check for email addresses: One of the checks against user email addresses is to do a lookup of the DNS MX record of it’s domain. Answer ‘n’ here if you want to disable this behaviour. Default: n
  • Force daily logout of mobile clients [n]: Enabling this option will force a daily log out of mobile users. You most likely do not want this option.
  • Enable MX record check for email addresses [n]: This only applies with open registration mode. When someone tries to create a new account it will only succeed if the provided email address exists.
  • Change name display order to 'Lastname Firstname' [n]: This will change the order in which user names are displayed in the chat from e.g. “Bob Dobbs” to “Dobbs Bob”.
  • Enable Elastic strict mapping [y]: This is deprecated, you can safely ignore this setting.
  • Time between full AD resyncs in minutes: The time to wait between full user/group syncs when using Active Directory. Setting this to low will impact performance, it is recommended to keep the default and manually resync when needed. Default: 1440 (1 day)
  • Were you given a custom runtime tag by the Grape team [n]: If you were given a custom runtime image docker tag by the Grape team say ‘y’ here and enter it in the next step.
  • Enable advanced performance tweaks [n]: Enables configuring performance related settings, fiddling around with these options can harm performance. Only set this up when being told to do so by the Grape team.
    • Override gunicorn workers [4]: This overrides the number of gunicorn worker processes. The default is enough for small to medium POCs, for a production setup values of ‘(2 x $num_cores) + 1’ are recommended by the gunicorn team. Valid values are 2 to 128, default value is 2.

Section sentry

  • Hostname of the Sentry instance: The hostname the Sentry instance will use, e.g. ‘sentry.grape.example.com’.
  • Email address of Sentry administrative user: This Email address will get Sentry’s report mails
  • Initial password of Sentry administrative user: This is the password that will be set on the first provisioning of Sentry. Changing it later will not change an already set password.
  • Email address sentry sends mails from: Email address Sentry sends mails from
  • Mailserver address to use: The address of the mailserver to use, can be either an IPv6 address or a domain name.
  • Mailserver port to use: The port to use on the server entered above.
  • Mailserver needs TLS: Set this to “yes” if your server requires TLS encryption enabled to send mails.
  • Username for SMTP authentification: If you need to authenticate with your mail server you can set the username here. (optional)
  • Password for SMTP authentification: If you need to authenticate with your mail server you can set the password here. (optional)

Integrations configuration

Some integrations need extra configuration options set, you can enable the dialogue by running grape configure --enable SERVICENAME.

Note: This only activates the integration in the configuration, to activate it you need to run grape install.

2FA/moreify

To enable two factor authentification using SMS you need to run grape configure --enable moreify

Necessary settings:

  • Please enter your moreify project: The moreify project id provided by the Grape team.
  • Please enter your moreify password: The moreify password provided by the Grape team.
  • Minimum delay between sending two SMS messages per user [20]: The amount of time to wait between sending two messages to the same user (in seconds)
  • Maximum number of SMS per month per user [50]: Maximum number of SMS to send to each user per month

Push notifications

The configuration of push notifications has been moved into the “grape” section of grape configure.

...
Enable push notifications [y]: y
Enable Apple push notifications [y]: y
Enable Google push notifications [y]: y
Enable Microsoft push notifications [y]: y
...

Trello

To enable the Trello integration simply run grape configure --enable trello followed by grape install.