CircleCI Server v3.x Installation Phase 4

Before you begin with the CircleCI server v3.x post installation phase, ensure you have run through Phase 1 – Prerequisites, Phase 2 - Core services installation and Phase 3 - Build services installation.

Phase 4: Post installation


Server installations include their own local orb registry. This registry is private to the server installation. All orbs referenced in project configs reference the orbs in the server orb registry. You are responsible for maintaining orbs. This includes:

  • Copying orbs from the public registry

  • Updating orbs that may have been copied prior

  • Registering your company’s private orbs if they exist

For more information, and steps to complete these tasks see the Orbs on Server guide.

Email Notifications

Build notifications are sent via email. Access the KOTS admin console. Get to the KOTS admin console by running the following, substituting your namespace: kubectl kots admin-console -n <YOUR_CIRCLECI_NAMESPACE> and locate the Email Notifications section in Settings and fill in the following details to configure email notifications for your installation.

  • Email Submission server hostname (required) - Host name of the submission server (e.g., for Sendgrid use

  • Username (required) - Username to authenticate to submission server. This is commonly the same as the user’s e-mail address.

  • Password (required) - Password to authenticate to submission server.

  • Port (optional) - Port of the submission server. This is usually either 25 or 587. While port 465 is also commonly used for email submission, it is often used with implicit TLS instead of StartTLS. Server only supports StartTLS for encrypted submission.

    Outbound connections on port 25 are blocked on most cloud providers. Should you select this port, be aware that your notifications may fail to send Enable StartTLS: Enabling this will encrypt mail submission.
  • Email from address (required) - The from address for the email.

StartTLS is used to encrypt mail by default, and you should only disable this if you can otherwise guarantee the confidentiality of traffic.

Click the Save config button to update your installation and re-deploy server.

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.