Skip to content

Commit

Permalink
docs: instructions for public data access setup in installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlougheed committed Sep 9, 2024
1 parent 28ed301 commit 65c9c1a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
20 changes: 18 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ utilize new variables generated during the OIDC configuration.

## 6. Configure permissions

### a. Create superuser permissions in the new Bento authorization service
### a. Create superuser permissions in the Bento authorization service

First, run the authorization service and then open a shell into the container:

Expand Down Expand Up @@ -334,7 +334,23 @@ bento_authz create grant \
'query:data' 'ingest:data' 'ingest:reference_material' 'delete:reference_material'
```

### c. *Optional step:* Assign portal access to all users in the instance realm
### c. Configure public data access for all users, including anonymous visitors (if desired):

To configure public data access, run the following command in the authorization service container. Note that with the
`full` value, **THIS GIVES FULL DATA ACCESS TO EVERYONE WHO VISITS YOUR INSTANCE!**

```bash
# Configure public data access
# ----------------------------
# The level below ("counts") preserves previous functionality. Other possible options are:
# - none - will do nothing.
# - bool - for censored true/false discovery, but in effect right now forbids access.
# - counts - for censored count discovery.
# - full - allows full data access (record-level, including sensitive data such as IDs), uncensored counts, etc.
bento_authz public-data-access counts
```

### d. *Optional step:* Assign portal access to all users in the instance realm

We added a special permission, `view:private_portal`, to Bento v12/v13 in order to carry forward the current
'legacy' authorization behaviour for one more major version. This permission currently behaves as a super-permission,
Expand Down
4 changes: 3 additions & 1 deletion docs/migrating_to_17.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ must be chosen and passed to the `bento_authz` CLI command below.

```bash
./bentoctl.bash shell authz
# The level below (counts) preserves previous functionality. Other possible options are:
# Configure public data access
# ----------------------------
# The level below ("counts") preserves previous functionality. Other possible options are:
# - none - will do nothing.
# - bool - for censored true/false discovery, but in effect right now forbids access.
# - counts - for censored count discovery.
Expand Down

0 comments on commit 65c9c1a

Please sign in to comment.