This documentation is for Stoplight customers that are on a self-hosted plan. Please contact firstname.lastname@example.org with any questions.
Before continuing, you'll need the following:
- Access to a new or existing Kubernetes cluster running Version 1.16+ (for sizing guidelines, see here)
kubectlCLI application, installed and configured to access the target cluster
- A valid Stoplight license file, provided by email@example.com
- An email provider configuration in order to enable email notifications (see Email Requirements)
- Optionally, SSL certificates for configuring SSL (see SSL Requirements)
Email is currently required to be setup during the Stoplight installation process. To complete this portion, you'll need:
- The hostname and port for your mail server, and whether or not SSL is required
- The mail server username and password, if needed
If SSL will be enabled for your installation, you will also need:
- SSL certificate in the PEM format (.crt)
- SSL secret key in the PEM format (.key)
In an offline environment?
If you are running in an offline or air-gapped environment, use the instructions here for the initial setup process.
Stoplight leverages a tool called KOTS in order to streamline the installation and deployment process of Stoplight on-premise. This software is used only for the management of the Stoplight service and licensing, and is not used within Stoplight directly.
If you have any questions or concerns regarding the use of this software, don't hesitate to reach out to firstname.lastname@example.org.
To install the KOTS kubectl module and begin the installation of Stoplight into the cluster, run the command below:
curl https://kots.io/install | bash \
kubectl kots install stoplight-platform/stable
As part of the installation process, you will be prompted to create a password which will be used for the administration interface.
Be sure to record this password! It will be needed later in order to register the Stoplight license and access the administration console.
Once the setup is completed, a local proxy will be created for accessing the administrative interface, prompting you for the previous administrator password:
Once authenticated, you will be able to upload your license file to register the license:
With the license in place, the Stoplight installation process will begin:
If you are not in an airgapped or offline environment, use the download Stoplight from the Internet button towards the bottom of the screen. Otherwise follow the instructions on the screen.
Once completed, there will be a quick test to ensure your environment meets the necessary requirements based on your license information (user counts, etc). Once completed, you should be greeted with the administrative interface:
Once completed, access the Stoplight ingress URL to use Stoplight and authenticate using the credentials provided by the configuration wizard.