Settings

The following environment variables should be changed in docker-compose.yml or the .env file before going live to production.

A starting point for production is placed in the Examples section

Mandatory

APP_ENV

DANGER ZONE

Changing this environment variable has an impact on the delivery of the data to the tax authorities.

Until the productive completion, the solution should be operated in development (set by default).

docker-compose.yml

APP_ENV: development

When the solution is ready to go productive, APP_ENV should be set to production.

docker-compose.yml

APP_ENV: production

Variable is case sensitive.

DEVELOPER_ID

Five-digit number which is assigned by ELSTER (cf. ELSTER Developer-ID).

DEVELOPER_NAME

Name of the software. Will be printed on the PDF transfer protocols in the lower left corner and will be disclosed on submissions to tax authorities.

CERTIFICATE_BASE64

The content of the .pfx certificate file issued by ELSTER. Encoded as Base64-String.

Convert the .pfx file to a base64 encoded string with for examples base64 file.pfx

For applying for the certificate see ELSTER Certificate.

The string gets encoded and stored during the start of the container as prod-soft-pse.pfx

CERTIFICATE_FILE

File name of the ELSTER certificate.

The production certificate is stored as prod-soft-pse.pfx

A test certificate test-soft-pse.pfx is stored inside the container for test operation.

CERTIFICATE_PIN

PIN to the ELSTER certificate file.

DB_*

SQL database credentials.

FILESYSTEM_CLOUD

Where should the PDF transfer protocols and ERiC logs be stored. In production it should be s3 for Amazon AWS S3.

By default: minio local S3 compatible solution

AWS_*

Settings and credentials for storing data in Amazon AWS S3-compatible services.

AWS_ACCESS_KEY_ID Access key ID generated in AWS Console or configured with MinIO.

AWS_SECRET_ACCESS_KEY Secret access key generated in AWS Console or configured with MinIO.

AWS_BUCKET Bucket name. Default: deric.

AWS_DEFAULT_REGION AWS region where data stored. Typically and default: eu-central-1.

Optional

API_TOKEN

Bearer token to authenticate for API /v2/ endpoints.

APP_LOCALE

Language in which validation and error messages get returned. Currently supported: de (Deutsch) and en (English). Default is de.

HOOK_*

See Webhook

REDIS_*

REDIS_HOST Host to connect with. Default: cache. Example: domain.tld

REDIS_PASSWORD Secret for user authentication. Default: null

REDIS_PORT Port on which host accepts connections. Default: 6379

REDIS_USERNAME Username for authentication. Default: default

REDIS_URL Sets all connection details in one variable. Default: null. Example: tcp://custom_username:[email protected]?database=0

SENTRY_DSN

Data Source Name for Sentry (Error Monitoring).

FEATURES_*

FEATURES_ATTACHMENTS_IN_S3

Pass attachments by name reference (link) in the subsequent message request to efficiently process and store attachments.

Works only for subsequent message.

Documented in Filings > Message > Features together with S3_ELSTER_ATTACHMENTS_* variables.