Installing the Backend API
The backend API component powers the Stoplight user-interface, connecting it to the backing datastore and other miscellaneous services.
The default port for this component component is TCP port
4060. The port can be
customized using the
PORT configuration variable.
This component must be able to receive incoming connections from the following components:
- Clients (ie, web browsers or Stoplight Studio instances)
This component must be able to make outgoing connections to the following components:
Make sure the following components are available before starting this component service:
RPM Package Installation
Prior to installing the RPM package, you will need to:
Install NodeJS v10.x
Have the Stoplight package repository installed and configured with your user-specific credentials
If you do not have access to a NodeJS package in your default repositories, run the command:
sudo rpm -Uvh https://rpm.nodesource.com/pub_10.x/el/7/x86_64/nodejs-10.16.0-1nodesource.x86_64.rpm
Once the installation has completed, verify the version installed with the command:
$ node --version v10.16.0
If you do not see a version starting
v10.16.0, contact Stoplight support for assistance.
Setting up the Package Repository
You can setup the Stoplight package repo by copying-and-pasting the contents below into a terminal:
# expose credentials to environment first REPO_USERNAME="myusername" REPO_PASSWORD="mypassword" # write credentials to repo file cat <<EOF | sudo tee /etc/yum.repos.d/stoplight.repo [stoplight] name=Stoplight Package Repository baseurl=https://$REPO_USERNAME:$REPO_PASSWORD@pkg.stoplight.io/rpm enabled=1 gpgcheck=1 repo_gpgcheck=1 gpgkey=https://pkg.stoplight.io/stoplight.key EOF
Make sure that the repository credentials are set before issuing the
Installing the Package
Once the repository is configured properly, you can install the package using the command:
sudo yum install stoplight-backend -y
To start the service, run the command:
sudo systemctl start stoplight-backend
Once started, you can see the status of the service using the command:
sudo systemctl status stoplight-backend
The configuration file for this component defaults to:
Be sure to customize any variables as needed to match your environment before starting the service. Any changes to the configuration will require a service restart in order to take effect.
sudo systemctl restart stoplight-backend
Full URL to the PostgreSQL database.
Secret used to encrypt session cookies and other metadata. Must be 32 characters.