Flow Enterprise Server uses the KOTS Administration Console for configuration of many of its settings. The console is located on port 8800 of the server that you installed Flow Enterprise Server on. For example, if you set your hostname to flow.mycompany.com during installation, the KOTS admin console is available at https://flow.mycompany.com:8800.
To set up configurations for Flow Enterprise Server, click Config in the top navigation.
There are several types of configurations available here. This article describes some of the most useful.
Flow Host Settings
There are several important settings in this area:
-
Flow URL: This is the URL that you want the site to be available on for your users. This should be a full URL in the form of
https://flow.mycompany.com. The URL must be anhttps://URL.Important: Your URL cannot have a trailing slash.
- Administrator E-mail Address: This should be an administrator email address that can be used in the case of severe system error. It must be a valid email address.
- Use TLS: Checking this box configures the ingress to use TLS. Use this when you don't have a proxy or load balancer set up to access Flow Enterprise Server. Enable this setting unless your proxy or load balancer is set up for TLS offloading.
E-Mail settings
Important: You can choose not to enable an email server. When you do, the user management functionality of Flow Enterprise Server is limited. It is highly recommended that you enable and configure an email server.
This section controls how Flow Enterprise Server sends email to your end users. To enter the email server settings, you must check the box next to Use E-mail Server. Setting up an email server is recommended to get the most out of Flow Enterprise Server.
- E-mail Server Hostname: This is the hostname or IP address of your email server.
- E-mail Server Port: This is the port used for your SMTP server. It is usually 25, 465, or 587.
- E-mail Server Login Method: This is the login method that should be used. The default of Plain is best in most cases.
- E-mail Server Username: This is the username used to authenticate with your email server.
- E-mail Server Password: This is the password used to authenticate the user.
- From E-mail Address: This is the address that all non-reporting emails are sent from. For example, if you set it to flow@mycompany.com, all the emails will have that in the From field.
- Reports from E-mail address: This is the address that reporting emails are sent from.
- Use TLS for E-mail Server: This checkbox enables TLS for communication with the SMTP server.
You can test the email settings you've entered by clicking Test Email Settings. This tests whether authentication is available and successful. It does not send an email.
Note: If your email server is an open relay and does not require authentication, you must input a single space character " " as your username and password values. A single space serves as a "none" entry, but the field cannot be left empty, otherwise an invalid null type value will be passed instead of the expected empty username and password.
Storage Filesystem
This section is where you define the location of temporary storage for your repository data. In the field Storage Path, enter the path on the server that you prepared. Learn more about the app directory requirements.
Database Settings
This section controls how Flow communicates with your PostgreSQL database. Learn more about preparing your database and Flow Enterprise Server system requirements.
External Database Settings
To set up an external database, choose External and fill in the available fields.
The fields available to you are:
- Frontend PostgreSQL server Hostname: This is the hostname or IP address of the database server,
- Frontend PostgreSQL server port: This is the port of the server. It usually defaults to 5432.
- Frontend PostgreSQL database name: The name of the database you created on the server.
- Frontend PostgreSQL user: The user that has ownership rights to the database.
- Frontend PostgreSQL user Password: The password for that user.
Important: There are matching Fundamentals BC options for each of these values. FundamentalBC values must be identical to the corresponding Frontend values for Flow Enterprise Server to work.
Embedded database settings
If you choose to use the embedded database method, you will be prompted to enter a directory on the server where PostgreSQL can store data. This allows us to persist your data between system restarts. Learn more about embedded database directory requirements.
Trusted Certificates
This section allows you to upload up to five trusted certificates. This is useful for customers who use self-signed certificates on their internal Git repository servers. Adding trusted certificates here is optional, and not recommended.
Important: This can be a very dangerous thing. Trusting data from a website can cause significant security holes in your environment. Be sure that the certificates you add here are really meant to be trusted.
To configure the certificates, upload the certificate files you want to trust in PEM format. Learn more about obtaining certificates for Flow Enterprise Server.
Advanced settings
Check the box next to Show advanced settings to enable configurations for advanced settings. This will allow you to set up authentication for BitBucket Cloud, GitHub Cloud, and GitLab Cloud, as well as help you tune and size your Flow Enterprise Server system to your environment.
Note: Be cautious when changing advanced settings. Some settings and their implications are outlined in this article, but it is best to reach out to Pluralsight Support before making changes to other settings that impact your environment.
BitBucket Cloud Settings
This section controls your integration with BitBucket Cloud. If you use BitBucket Server, this section does not apply to you. To integrate with BitBucket Cloud, click the option button next to Enabled and fill out the BitBucket auth key and auth secret.
These fields are an OAuth key and secret pair you configure in BitBucket Cloud. For more information on how to configure this integration in both the KOTS admin console and Flow itself, read about how to Register Flow Enterprise Server with BitBucket Cloud.
GitHub Cloud Settings
This section controls your integration with GitHub Cloud. If you use GitHub Enterprise Server, this section does not apply to you. To integrate with GitHub Cloud, click the option button next to Enabled and fill out the GitHub auth key and auth secret.
These fields are an OAuth key and secret pair that you configure in GitHub Cloud. For more information on how to configure this integration in both the KOTS admin console and Flow itself, read about how to Register Flow Enterprise Server with GitHub Cloud.
GitLab Cloud Settings
This section controls your integration with GitLab's cloud offering. If you use a self-hosted version of GitLab, this section does not apply to you. To integrate with GitLab Cloud, click the option button next to Enabled and fill out the GitLab auth key and auth secret.
These fields are an OAuth key and secret pair that you configure in GitLab Cloud. For more information on how to configure this integration in both the KOTS admin console and Flow itself, read about how to Register Flow Enterprise Server with GitLab Cloud.
Disk Pressure Check Settings
To prevent your Flow Enterprise Server cluster from running into a forced eviction due to a lack of disk space, go to the Disk Pressure Check Settings section and check the box next to Enable Disk Pressure Check and Scale Down. Leave Minimum Disk Free Percentage and Cronjob schedule at their default values.