Environment Variables
Environment Variables are found in the .env file. Please see the example.env file to create your own .env file when running locally.
These variables are strictly for use within Cloud Document Maker and not passed to it via the API.
Environment variables in the Development and Production instances within AWS Elastic Beanstalk are configured within the AWS Console and are not read from the .env file.
| Setting | Description |
|---|---|
| DOCX_TO_PDF_METHOD | The method of converting docx files to PDFs. ConvertAPI (default) / LibreOffice (experimental) / Gotenberg (experimental) |
| CONVERTAPI_SECRET | The Secret Key for converting documents using the Convert API |
| GOTENBERG_URL | The URL of the hosted Gotenberg service |
| AWS_ACCESS_KEY_ID | The access key ID for accessing AWS resources |
| AWS_SECRET_ACCESS_KEY | The secret access key for accessing AWS resources |
| SQS_URL | The URL for the Simple Queue Service (SQS) which is used by Celery |
| S3_BUCKET_NAME | The name of the bucket where completed files are stored |
| SQL_SERVER_NAME | The name of the SQL server where the log database lives |
| SQL_DATABASE_NAME | The name of the log database |
| SQL_USERNAME | The username used to connect to the SQL server instance |
| SQL_PASSWORD | The username used to connect to the SQL server instance |
| WRITE_DOCS_TO_S3 | Whether completed documents should be written to S3. Yes / No |