The following table contains a list of environment variables that you can set to configure the DocSpring application. Variables are required unless they are marked as Optional.

If you are using Convox on AWS: Convox sets this variable automatically. If you are using Google Cloud: We run an instance of Redis on the server, and this is configured by default. You can set the *REDIS_URL* variable to use a different Redis. | | SECRET_KEY_BASE | 64 random bytes used for security in Rails (e.g. user sessions.) Run the following command in your terminal to generate this string:  openssl rand -hex 64 | | SUBMISSION_DATA_ENCRYPTION_KEY | 32 random bytes used as the encryption key for data in the database. Run the following command in your terminal to generate this string:  openssl rand -hex 32 | | ADMIN_EMAIL  (Optional. Default: [email protected]) | When the server starts, it will connect to postgres, set up the database, and create an admin user with the email ADMIN_EMAIL. | | ADMIN_NAME  (Optional. Default: Admin) | Full name of the admin user. | | ADMIN_PASSWORD  (Optional. Default: 075d082e403) | Password for the admin user. Tip: Generate a secure password by running: openssl rand -base64 9 | | DOCSPRING_ECR_AWS_ACCESS_KEY_ID | (For Google Cloud Setup) AWS API token that is used to access the DocSpring Enterprise docker image from ECR (Elastic Container Registry.) This API token will be provided to you via email and is unique to your organization.. | | FORMAPI_ECR_AWS_ACCESS_KEY_SECRET | AWS API token secret to access the DocSpring Enterprise docker image. | | GOOGLE_MAPS_GEOCODING_API_KEY (Optional: Leave blank to disable geolocation.) | Google Maps API key. Used to geolocate submission IP addresses when people fill out the online form. Leave blank to disable IP address geolocation. | | GOOGLE_CLOUD_SQL_INSTANCE_NAME | Optional (for Google Cloud): The “Instance connection name” for your Cloud SQL database. e.g. docspring-enterprise-202617:us-central1:docspring-production | | GCS_ACCESS_KEY_ID | Google Cloud Storage API access key (from the Interoperability tab) | | GCS_ACCESS_KEY_SECRET | Google Cloud Storage API secret (from the Interoperability tab) | | GCS_UPLOADS_BUCKET | The name of your Google Cloud Storage bucket. | | AWS_ACCESS_KEY_ID | AWS S3 access key for file storage | | AWS_ACCESS_KEY_SECRET | AWS S3 secret key for file storage | | AWS_UPLOADS_S3_BUCKET | AWS S3 bucket to store files | | AWS_UPLOADS_S3_REGION | Region for AWS S3 bucket, e.g. us-east-1 | | PDF_URL_EXPIRATION_TIME | Set the expiration time (in seconds) for PDF download URLs. Must be an integer between 60 and 604801 (7 days.) (AWS does not allow higher values.) Default: 900 | | POSTMARK_API_TOKEN | API token for your PostMark account | | DISABLE_EMAILS | Set to true to disable sending emails. (Can be useful during the initial setup.) Make sure you unset this variable before configuring an email service. | | POSTMARK_API_TOKEN | API key for your Postmark account | | SENDGRID_API_KEY | API key for your SendGrid account | | SENDGRID_USERNAME | Note: This is only for legacy support. You should use SENDGRID_API_KEY Username for your SendGrid account. | | SENDGRID_PASSWORD | Note: This is only for legacy support. You should use SENDGRID_API_KEY Password for your SendGrid account. (Make sure you have 2FA disabled.) | | MAILGUN_API_KEY | Mailgun API key | | MAILGUN_DOMAIN | Email domain to use for Mailgun | | GMAIL_USERNAME | Gmail Username | | GMAIL_PASSWORD | Gmail Password | | GMAIL_DOMAIN | Your G Suite domain | | AWS_SES_ACCESS_KEY_ID | AWS SES Access Key ID (for sending emails) | | AWS_SES_SECRET_ACCESS_KEY | AWS SES Secret Access Key | | SENTRY_DSN | Sentry DSN for error reporting (backend errors) | | SENTRY_JS_DSN | Sentry DSN for error reporting (frontend errors) | | SKYLIGHT_AUTHENTICATION | Authentication token for Skylight.io (performance monitoring) | | DISABLE_BECOME_USER | Set to true to disable the “Become User” feature in the admin interface. | | ADMIN_API_TOKEN | Set a predefined API token that can be used to authenticate for any API endpoints. Authenticate using a basic auth Authorization header where the username is the string ADMIN_API_TOKEN, and the password is the token that you set in the ADMIN_API_TOKEN environment variable. (This authentication method can be used for admin API endpoints that allow templates to be imported and exported, among other things.) See: Admin API Endpoints | | FIELD_NAME_DEBOUNCE_INTERVAL | Default: 350. Set this to a higher number of milliseconds to increase the debounce time when typing a field name in the template editor. | | AWS_CLOUDWATCH_ACCESS_KEY_ID | Optional: AWS access key ID for an IAM user that has the CloudWatchAgentServerPolicy policy, for sending Sidekiq metrics to Cloudwatch | | AWS_CLOUDWATCH_ACCESS_KEY_SECRET | Optional: AWS access key secret for an IAM user that has the CloudWatchAgentServerPolicy policy, for sending Sidekiq metrics to Cloudwatch | | AWS_CLOUDWATCH_REGION | Optional: e.g. us-east-1 | | AWS_CLOUDWATCH_SIDEKIQ_NAMESPACE | Optional: Namespace for the Sidekiq metrics in CloudWatch. “Sidekiq” (default), “Sidekiq-Staging”, “Sidekiq-Prod”, etc. | | TEMPLATE_DEFAULT_TYPEFACE | Optional: Set the default typeface for templates. Default: Helvetica | | TEMPLATE_DEFAULT_FONT_SIZE | Optional: Set the default text font size  for templates. Default: 11 | | TEMPLATE_DEFAULT_TEXT_COLOR | Optional: Set the default text color  for templates. Default: 444444 | | SYNCHRONOUS_API | Optional: Enable long-lived synchronous API requests. (e.g. Wait before returning processed PDFs.) This is fine for most workloads, but not recommended for high volumes. If you process very high volumes of PDFs and need better concurrency for long-lived HTTP requests, you may want to deploy our Go API proxy service in front of the application. Contact us for more details. |

Please contact [email protected] if you have any questions or feature requests.