PhraseApp On-Premise Environment Variables
All configuration is done via the setting of environment variables inside the
phraseapp.env file. An example file with arbitrary values could look similar to this purely illustrative file.
192.168.99.100 should be replaced by your actually used host names or IPs reachable from the Docker container running PhraseApp On-Premise. Also, make sure to replace the secrets at the end of the file according to the section about SECRETs at the end of this document:
This file may not contain double-quotes “ - do not enclose string values with any quotes. See docker documentation for more on Environment variable settings.
||The Database URL to connect to, e.g.
mysql2://user:pass@db-host:port/db?local_infile=true. You must set the scheme to the pseudo-scheme
mysql2 for the Ruby application of PhraseApp On-Premise to be able to connect to your MySQL server. User and pass must be url-encoded with the [Percent-encoding](https://en.wikipedia.org/wiki/Percent-encoding).
||The URL of the Elasticsearch cluster to connect to, e.g.
||The URL of the Redis key-value store to connect to with the scheme "redis", e.g.
||Hostname used for links in emails e.g.
||URL used for linked assets, such as images if you're employing static asset host like a CDN. You can always also use the same value as for BASE_URL, e.g.
SMTP mail settings
Available SMTP mail server settings are explained in the smtp_settings section of the Ruby on Rails guides on mailer configuration.
||Hostname of the SMTP server, e.g.
||SMTP port, e.g.
||Flag whether STARTTLS detection is enabled
||Authentication type, can be
||SMTP Domain, necessary for certain SMTP relay configurations also called HELO domain, e.g.
||Sender address for outgoing emails, e.g.
||Set to 1 if you want the server to raise exceptions when mails cannot be send or to 0 if you want to ignore email delivery failures. We suggest setting this to 1 especially if you're in the process of testing the SMTP server connection.
||Disable the registration form to create new accounts for your system. This should be set to 0 for the first installation. If set to 0 anyone with access to PhraseApp On-Premise web interface can create new accounts. If set to 1 no one can create new accounts on the PhraseApp On-Premise installation.
Disable Rate Limiting
||Setting this flag to `true` disables rate limiting for both concurrent number of requests and requests per time window for rate limited endpoints. By default only 2 concurrent requests and 200 requests per 5 minutes are allowed.
There are several secret tokens that are used to encrypt data in PhraseApp On-Premise, such as the content of cookies and user passwords. Please make sure to use alphanumeric strings with at least 64 characters for all variables with names containing “SECRET”.
You must store these tokens in a safe location or your encrypted data such as user passwords will not work after you install updates or reinstall the system!