Configuration
The table below gives an overview of things you can configure in your Texterify instance. Make sure to also check out the .env
file.
Name | Default | Description |
---|---|---|
APP_HOST | example.com | The fully qualified name of the web server (for example used for constructing email links). |
ASSET_HOST | example.com | The fully qualified name of the asset server. This is normally the same as the APP_HOST. |
EMAIL_CONFIRMATION_REQUIRED | false | Whether email confirmation is required or not. If set to true make sure to also configure your email server. |
DB_PROD_HOST | db | The database host. |
DB_PROD_USERNAME | postgres | The database username. |
DB_PROD_DATABASE | texterify_production | The name of your database. |
DB_PROD_PASSWORD | The password of your database user if needed. | |
http_proxy | Specify a HTTP proxy for your application. | |
SIDEKIQ_REDIS_SERVER_URL | redis://redis:6379/0 | The Sidekiq Redis server url. Learn more at Sidekiq basics and Sidekiq using Redis. |
SIDEKIQ_REDIS_CLIENT_URL | redis://redis:6379/0 | The Sidekiq Redis client url. Learn more at Sidekiq basics and Sidekiq using Redis. |
External services
Texterify makes use of some external services. Below you find instructions on how to configure them.
E-Mail
You need to configure a mail server so Texterify can send emails (e.g. password forgot emails). Make use of the following configuration options to integrate your mail server or provider:
Name | Default | Description |
---|---|---|
SMTP_FROM_EMAIL | no-reply@example.com | Set the from and reply-to email of the emails (e.g. no-reply@example.com). In previous versions only the domain could be changed via MAILER_HOST. |
SMTP_ADDRESS | localhost | The address of the mail server. |
SMTP_PORT | 25 | The port of the mail server. |
SMTP_DOMAIN | If you need to specify a HELO domain. | |
SMTP_USER_NAME | Specify a username if your server requires authentication. | |
SMTP_PASSWORD | Specify a password if your server requires authentication. | |
SMTP_AUTHENTICATION | You can specify the authentication type here. Choose one of the following if needed:
| |
SMTP_ENABLE_STARTTLS_AUTO | true | Determines if STARTTLS is enabled in your SMTP server and starts to use it. |
SMTP_OPENSSL_VERIFY_MODE | When you use TLS you can define how OpenSSL checks the certificate. Choose one of the following if needed:
| |
SMTP_TLS | false | Enables the SMTP connection to use SMTP/TLS (SMTPS: SMTP over direct TLS connection). |
Machine translation
Texterify does all the handling around machine translation for you, but the text is finally translated by DeepL. Therefore if you want to use machine translation you need to configure DeepL:
Name | Default | Description |
---|---|---|
DEEPL_API_TOKEN | If you want to use machine translation you need to create an account on www.deepl.com and set your API token here. |
This feature requires communication outside of your network. If a proxy is required for communication you can set the proxy with the http_proxy
environment variable.
Over the air translations
The over the air feature works by hosting the translation files on the Google Cloud. If you need to make use of this feature you will have to create a storage bucket and configure it:
Name | Default | Description |
---|---|---|
GOOGLE_CLOUD_PROJECT | The name of your Google Cloud project. | |
GOOGLE_CLOUD_KEYFILE | The Google Cloud key file used for authentication. See here for more information. | |
GOOGLE_CLOUD_OTA_BUCKET_NAME | The name of the bucket used for storing the translation bundles. |
This feature requires communication outside of your network. If a proxy is required for communication you can set the proxy with the http_proxy
environment variable.