Skip to content

Commit 0edac3c

Browse files
committed
Document admin read-only mode
1 parent 53e84ad commit 0edac3c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,23 @@ light.lock(Stoplight::Color::GREEN)
511511
light.unlock
512512
```
513513

514+
### Admin
515+
516+
Admin Panel can work in an read-only which could be useful for observability. To enabled read-only mode:
517+
518+
```ruby
519+
Stoplight::Admin.configure do |config|
520+
config.read_only = true
521+
end
522+
```
523+
524+
Read-only mode could be turned on for a pre-built docker image by passing `STOPLIGHT_ADMIN_READ_ONLY` environment
525+
variable:
526+
527+
```sh
528+
docker run -e REDIS_URL=redis://localhost:6378 -e STOPLIGHT_ADMIN_READ_ONLY=true --net=host bolshakov/stoplight-admin
529+
```
530+
514531
## Rails Integration
515532

516533
Wrap controller actions with minimal effort:

0 commit comments

Comments
 (0)