Skip to content

Commit

Permalink
Document user with limited rights
Browse files Browse the repository at this point in the history
This patch adds documentation on how to add and use a user with limited
access rights for the display.
  • Loading branch information
lkiesow committed Feb 12, 2024
1 parent c51e29f commit a1fa3b6
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,28 @@ https://github.com/virtUOS/opencast-ca-display/assets/1008395/ead22cd2-9d7a-4d26
- The display and laptop do not know about each other
- The laptop is running an Opencast capture agent
- When the laptop starts capturing video, the display shows an active recording

## Opencast User

To improve security, you can limit the access rights for the Opencast user by
creating a user which has only read access to the capture agent status API and
nothing else.

To do this, first create a new security rule in your Opencast's
`etc/security/mh_default_org.xml` allowing read access for a new role
`ROLE_CAPTURE_AGENT_CALENDAR`:

```xml
<!-- Enable capture agent updates and ingest -->
<sec:intercept-url pattern="/capture-admin/agents/**" method="GET" access="ROLE_ADMIN, ROLE_CAPTURE_AGENT, ROLE_CAPTURE_AGENT_CALENDAR" />
<sec:intercept-url pattern="/capture-admin/**" access="ROLE_ADMIN, ROLE_CAPTURE_AGENT" />
```

Next, go to the Opencast REST Docs → `/user-utils` and fill out the form for
`POST /` with data like this:

- username: `ca-display`
- password: `secret-password`
- roles: `["ROLE_CAPTURE_AGENT_CALENDAR"]`

You should now be able to use this new user.

0 comments on commit a1fa3b6

Please sign in to comment.