Configuring External Services
On This Page
This page describes how to configure external services for use with a CircleCI server v4.x installation.
|If you are using your own PostgreSQL instance, it needs to be version 12.1 or higher.|
If you choose to use an external PostgreSQL instance, add the following to your
postgresql: internal: false postgresqlHost: <domain> # The domain or IP address of your PostgreSQL instance postgresqlPort: <port> # The port of your PostgreSQL instance
Best practices for PostgreSQL
Consider running at least two PostgreSQL replicas to allow recovery from primary failure and for backups. The table below shows the recommended specifications for PostgreSQL machines:
|# of Daily Active Users||# of PostgreSQL Replicas||CPU||RAM||Disk||NIC Speed|
50 - 250
250 - 1000
1000 - 5000
Backing Up PostgreSQL
PostgreSQL provides official documentation for backing up and restoring your PostgreSQL 12 install, which can be found here.
We strongly recommend the following:
Taking daily backups.
Keeping at least 30 days of backups.
Using encrypted storage for backups as databases might contain sensitive information.
Performing a backup before each upgrade of CircleCI server.
|If using your own MongoDB instance, it needs to be version 3.6 or higher.|
If you choose to use an external MongoDB instance, add the following to your
mongodb: internal: false hosts: <hostname:port> # this can be a comma-separated list of multiple hosts for sharded instances ssl: <ssl-enabled> # If using an SSL connection with custom CA or self-signed certs, set this # to true tlsInsecure: false # Any other options you'd like to append to the MongoDB connection string. # Format as query string (key=value pairs, separated by &, special characters # need to be URL encoded) options: <additional-options> auth: database: <authentication-source-database mechanism: SCRAM-SHA-1
Help make this document better
This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guidefirst).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.
You can also visit our support site to find support articles, community forums, and training resources.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.