Update API documentation with new feature flag. Fix tasker redis host-port variable config.

This commit is contained in:
Ross McDonald
2018-04-12 12:32:26 -05:00
parent b6cb92440b
commit 631f64e175
2 changed files with 18 additions and 2 deletions

View File

@@ -224,3 +224,19 @@ curl -v http://localhost:3030/health
```
If the API was installed and configured properly, you will receive an HTTP 200 response back.
## Other Configuration Options
### Disabling Registration
New users can be prevented from registering with Stoplight by exposing a
`DISABLE_REGISTRATION=true` variable either through the environment or
configuration.
If this option is enabled, new user registration requests will receive the
following error when attempting to register:
> User registration has been temporarily disabled. Please contact your administrator.
_Please note_, enabling this feature does not prevent existing users from
inviting new users.

View File

@@ -81,7 +81,7 @@ TASKER_MODE="shell"
CORE_ROOT="/opt/stoplight-hub-builder"
# Redis host:port to connect to (must be available before starting service)
TASKER_REDIS_HOSTPORT="redis:6379"
TASKER_REDIS_HOSTPORT="redis://redis:6379"
# Redis password, if any
TASKER_REDIS_PASSWORD=""
# Redis database
@@ -122,7 +122,7 @@ TASKER_MODE="shell"
CORE_ROOT="/opt/stoplight-hub-builder"
# Redis host:port to connect to (must be available before starting service)
TASKER_REDIS_HOSTPORT="redis:6379"
TASKER_REDIS_HOSTPORT="redis://redis:6379"
# Redis password, if any
TASKER_REDIS_PASSWORD=""
# Redis database