diff --git a/articles/enterprise/components/api-overview.md b/articles/enterprise/components/api-overview.md index 02bdf7d..f3d4a7e 100644 --- a/articles/enterprise/components/api-overview.md +++ b/articles/enterprise/components/api-overview.md @@ -116,40 +116,6 @@ API can be configured either by configuration file or through the environment. > The same configuration variables can be used regardless of installation type > (container or package-based). -### RPM Package - -The Stoplight API configuration file is located at the location: - -```bash -/etc/stoplight-api/stoplight-api.cfg -``` - -Be sure to customize any variables as needed to match your environment before -starting the API service. - -> Any changes to the API configuration require a service restart in order to -> take effect. - -### Docker - -To expose configuration variables to the Docker runtime, either write them to a -file and use the `--env-file` argument: - -```bash -cat <api-env-vars -SL_APP_HOST="..." -... -EOF - -docker run --env-file api-env-vars ... -``` - -Or you can expose them one at a time with the `-e` flag: - -```bash -docker run -e SL_APP_HOST=https://stoplight.example.com ... -``` - ### Variables #### SIGN_SECRET @@ -244,6 +210,40 @@ following error when attempting to register: > User registration has been temporarily disabled. Please contact your administrator. +### RPM Package + +The Stoplight API configuration file is located at the location: + +```bash +/etc/stoplight-api/stoplight-api.cfg +``` + +Be sure to customize any variables as needed to match your environment before +starting the API service. + +> Any changes to the API configuration require a service restart in order to +> take effect. + +### Docker + +To expose configuration variables to the Docker runtime, either write them to a +file and use the `--env-file` argument: + +```bash +cat <api-env-vars +SL_APP_HOST="..." +... +EOF + +docker run --env-file api-env-vars ... +``` + +Or you can expose them one at a time with the `-e` flag: + +```bash +docker run -e SL_APP_HOST=https://stoplight.example.com ... +``` + ## Running ### RPM Package diff --git a/articles/enterprise/components/app-overview.md b/articles/enterprise/components/app-overview.md index 2ada5cb..6c6d645 100644 --- a/articles/enterprise/components/app-overview.md +++ b/articles/enterprise/components/app-overview.md @@ -107,40 +107,6 @@ either by configuration file or through the environment. > The same configuration variables can be used regardless of installation type > (container or package-based). -### RPM Package - -The Stoplight App configuration is located at the location: - -```bash -/etc/stoplight-app/stoplight-app.cfg -``` - -Be sure to customize any variables as needed to match your environment before -starting the API service. - -> Any changes to the API configuration require a service restart in order to -> take effect. - -### Docker - -To expose configuration variables to the Docker runtime, either write them to a -file and use the `--env-file` argument: - -```bash -cat <app-env-vars -SL_API_HOST="..." -... -EOF - -docker run --env-file app-env-vars ... -``` - -Or you can expose them one at a time with the `-e` flag: - -```bash -docker run -e SL_API_HOST=https://stoplight-api.example.com ... -``` - ### Variables #### SL_APP_HOST @@ -199,6 +165,40 @@ The `SL_PUBS_INGRESS` variable is the URL to the Stoplight Pubs instance admin A SL_PUBS_INGRESS="https://pubs.example.com:9098" ``` +### RPM Package + +The Stoplight App configuration is located at the location: + +```bash +/etc/stoplight-app/stoplight-app.cfg +``` + +Be sure to customize any variables as needed to match your environment before +starting the API service. + +> Any changes to the API configuration require a service restart in order to +> take effect. + +### Docker + +To expose configuration variables to the Docker runtime, either write them to a +file and use the `--env-file` argument: + +```bash +cat <app-env-vars +SL_API_HOST="..." +... +EOF + +docker run --env-file app-env-vars ... +``` + +Or you can expose them one at a time with the `-e` flag: + +```bash +docker run -e SL_API_HOST=https://stoplight-api.example.com ... +``` + ## Running ### RPM Package diff --git a/articles/enterprise/components/exporter-overview.md b/articles/enterprise/components/exporter-overview.md index d706096..26137e5 100644 --- a/articles/enterprise/components/exporter-overview.md +++ b/articles/enterprise/components/exporter-overview.md @@ -89,7 +89,7 @@ sudo yum install stoplight-exporter -y ### Docker -To install the API component with Docker, run the command below: +To install the Exporter component with Docker, run the command below: ```bash docker pull quay.io/stoplight/exporter @@ -108,39 +108,6 @@ environment. > The same configuration variables can be used regardless of installation type > (container or package-based). -### RPM Package - -The Stoplight Exporter configuration is located at the location: - -```bash -/etc/stoplight-exporter/stoplight-exporter.cfg -``` - -Be sure to customize any variables as needed to match your environment before -starting the API service. - -> Any changes to the API configuration require a service restart in order to -> take effect. - -### Docker - -To expose these to the Docker runtime, either write them to a file and use the `--env-file` argument: - -```bash -cat <exporter-env-vars -SL_APP_HOST="..." -... -EOF - -docker run --env-file exporter-env-vars ... -``` - -Alternatively, you can expose them one at a time with the `-e` flag: - -```bash -docker run -e SL_APP_HOST=https://stoplight.example.com ... -``` - ### Variables #### SL_APP_HOST @@ -163,13 +130,48 @@ SL_API_HOST="https://stoplight-api.internal.example.com:3030" The `SL_EXPORTER_HOST` variable is the full URL to the Stoplight Exporter instance. +``` SL_EXPORTER_HOST="https://stoplight-exporter.internal.example.com" +``` + +### RPM Package + +The Stoplight Exporter configuration is located at the location: + +```bash +/etc/stoplight-exporter/stoplight-exporter.cfg +``` + +Be sure to customize any variables as needed to match your environment before +starting the Exporter service. + +> Any changes to the Exporter configuration require a service restart in order +> to take effect. + +### Docker + +To expose these to the Docker runtime, either write them to a file and use the `--env-file` argument: + +```bash +cat <exporter-env-vars +SL_APP_HOST="..." +... +EOF + +docker run --env-file exporter-env-vars ... +``` + +Alternatively, you can expose them one at a time with the `-e` flag: + +```bash +docker run -e SL_APP_HOST=https://stoplight.example.com ... +``` ## Running ### RPM Package -To start the API server, run the command: +To start the Exporter server, run the command: ```bash sudo systemctl start stoplight-exporter