Skip to content

Commit 467759f

Browse files
authored
update docs for database access (#184)
* improve docs + screenshots * fix roles
1 parent 1fc386e commit 467759f

File tree

11 files changed

+53
-2
lines changed

11 files changed

+53
-2
lines changed
203 Bytes
Loading
143 Bytes
Loading
-577 Bytes
Loading
-692 Bytes
Loading
-737 Bytes
Loading
6.22 KB
Loading
5.07 KB
Loading
-1.25 KB
Loading
19 KB
Loading

docs/docs/usage/module/role_management.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Roles that have access to the module's schemas but are not part of the module co
3939

4040
- **Create and grant roles** — create all missing module roles (optionally with a suffix) and grant the configured schema permissions.
4141
- **Create user** — create a new PostgreSQL user (a role with LOGIN privilege) with an optional password.
42-
- **Configure database access** — opens a dialog to manage CONNECT privileges on the database. Shows checkboxes for PUBLIC (grants all users access), each existing module role, and any other roles that have explicit CONNECT. Use this to restrict which roles can connect to the database.
42+
- **Configure database access** — opens a dialog to manage `CONNECT` privileges on the database (see below).
4343

4444
### Context menu (right-click)
4545

@@ -62,3 +62,25 @@ Right-click on a **user** to access:
6262
Roles can also be created automatically during module installation or upgrade
6363
by enabling the **Create and grant roles** option in the install/upgrade dialog.
6464
The role management dialog is useful for post-installation adjustments.
65+
66+
## Configure database access
67+
68+
The **Configure database access** button opens a dedicated dialog for managing
69+
`CONNECT` privileges on the current database.
70+
71+
![Database access dialog](../../assets/images/screenshots/10b_access_dialog.png)
72+
73+
By default, PostgreSQL grants `CONNECT` to the `PUBLIC` pseudo-role, meaning
74+
**any** user on the server can connect to every database. This dialog lets you
75+
tighten that:
76+
77+
- **PUBLIC** — a checkbox at the top controls whether all users can connect.
78+
When checked, individual role checkboxes are disabled (greyed out) because
79+
they are redundant — everyone already has access.
80+
- **Module roles** — when PUBLIC is unchecked, you can grant or revoke
81+
`CONNECT` for each existing module role individually.
82+
- **Other roles** — any non-module roles that have an explicit `CONNECT` grant
83+
are also listed so you can revoke them if needed.
84+
85+
Click **Apply** to execute the changes. The dialog stays open so you can make
86+
further adjustments. Changes take effect immediately on the server.

0 commit comments

Comments
 (0)