TerribleDev/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update api and gitlab component articles

Browse Source
This commit is contained in:
Ross McDonald
2018-05-03 14:50:41 -05:00
parent 34de403119
commit 6d8c850303
2 changed files with 49 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
articles/enterprise/components/api.md
View File

@@ -20,6 +20,15 @@ datastore and other miscellaneous Stoplight services.
> * Gitlab
> * Exporter
> * Prism
>
> In addition, the API makes use of
> [websocket](https://en.wikipedia.org/wiki/WebSocket) connections for real-time
> notifications and updates to application users. In particular, websockets are
> used for:
>
> * Displaying editor notifications when multiple users are editing the same file
> * Displaying build logs while a Hub or spec is being built
> * Displaying notifications for when a Hub or spec build is completed
> #### Component Dependencies
>
@@ -156,6 +165,11 @@ SL_COOKIE_DOMAIN="example.com"
For example, if Stoplight is being served from the `stoplight.example.com`
domain, set this variable to `example.com`.
> This setting is used for
> [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
> verification. If you are unable to make requests to the API from the app, then
> this is most likely the cause.
#### SL_APP_HOST
The `SL_APP_HOST` variable is the full URL to the Stoplight app component.

36
articles/enterprise/components/gitlab.md
View File

@@ -106,11 +106,24 @@ The Stoplight GitLab configuration is located at:
/etc/gitlab/gitlab.rb
```
The above file encompasses all of the different configuration options exposed by GitLab. This guide only covers those specific to Stoplight.
The above file encompasses all of the different configuration options exposed by
GitLab. This guide only covers those specific to Stoplight.
> For documentation on other GitLab configuration options, see the official
> documentation [here](https://docs.gitlab.com/omnibus/README.html#configuring)
##### external_url
`external_url` is the canonical URL for the Gitlab instance (scheme, hostname,
and port included).
```
external_url 'http://stoplight.example.com:8080'
```
> If you are configuring GitLab to send emails, set the `external_url` to the
> URL of the **Stoplight App** component, and not GitLab itself.
#### Starting the Service
To start GitLab for the first time, run the commands:
@@ -213,3 +226,24 @@ Once the configuration changes are made, issue a `gitlab-ctl reconfigure` for th
For more information on configuring Redis, see the official GitLab documentation
[here](https://docs.gitlab.com/omnibus/settings/redis.html).
#### Can I specify GitLab users as administrators?
Yes, GitLab administrators can be selected by editing the user you would like to
assign as an admin. Administrative rights can be set under the "Access" section
of the user modification screen in GitLab.
> Please note, GitLab administrators have administrative rights in Stoplight as
> well. Administrators can see and edit all projects hosted within Stoplight.
#### Can I allow users created in GitLab to have access to Stoplight?
Yes, in order for a GitLab-created user to have access to the Stoplight
platform, an impersonation token must be created for their account. The
impersonation token management screen can be found in the user administration
screen, under the "Impersonation Tokens" tab.
To create a Stoplight access token, make sure:
* The name of the token is equal to `stoplight`
* The token must have `api` scope