Skip to content

docs: format five pages with prettier #512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
retr0h merged 1 commit into from
Sep 17, 2026
Merged

docs: format five pages with prettier #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/docs/sidebar/features/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ flowchart TD

Built-in roles expand to these default permissions:

| Role | Permissions |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Role | Permissions |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `admin` | `agent:read`, `agent:write`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `audit:read`, `command:execute`, `command:shell`, `file:read`, `file:write`, `docker:read`, `docker:write`, `docker:execute`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `power:execute`, `process:read`, `process:execute`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `write` | `agent:read`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `file:read`, `file:write`, `docker:read`, `docker:write`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `process:read`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `read` | `agent:read`, `node:read`, `network:read`, `job:read`, `health:read`, `file:read`, `docker:read`, `cron:read`, `sysctl:read`, `ntp:read`, `timezone:read`, `process:read`, `user:read`, `package:read`, `log:read`, `certificate:read`, `service:read` |
| `write` | `agent:read`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `file:read`, `file:write`, `docker:read`, `docker:write`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `process:read`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `read` | `agent:read`, `node:read`, `network:read`, `job:read`, `health:read`, `file:read`, `docker:read`, `cron:read`, `sysctl:read`, `ntp:read`, `timezone:read`, `process:read`, `user:read`, `package:read`, `log:read`, `certificate:read`, `service:read` |

`command:execute` and `command:shell` are two distinct permissions: the former
guards the argv-only `exec` endpoint, the latter guards the `/bin/sh -c` based
Expand Down
15 changes: 7 additions & 8 deletions docs/docs/sidebar/features/command-execution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,9 @@ role can be scoped to structured commands without also granting shell access:
Only the built-in `admin` role includes either permission by default. The
`write` and `read` roles do not.

> **Upgrading?** A custom role or token that was granted only
> `command:execute` no longer reaches the `shell` endpoint -- it now also needs
> `command:shell`. Add `command:shell` to any custom role or token that should
> keep shell access.
> **Upgrading?** A custom role or token that was granted only `command:execute`
> no longer reaches the `shell` endpoint -- it now also needs `command:shell`.
> Add `command:shell` to any custom role or token that should keep shell access.

To grant command execution to a custom role:

Expand Down Expand Up @@ -113,13 +112,13 @@ NATS, agent, and authentication settings.

## Permissions

| Operation | Permission |
| --------- | ---------------- |
| Operation | Permission |
| --------- | ----------------- |
| Exec | `command:execute` |
| Shell | `command:shell` |

Only the `admin` role includes `command:execute` or `command:shell` by
default. Grant them to other roles or tokens explicitly when needed.
Only the `admin` role includes `command:execute` or `command:shell` by default.
Grant them to other roles or tokens explicitly when needed.

## Related

Expand Down
22 changes: 11 additions & 11 deletions docs/docs/sidebar/usage/cli/client/node/user/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ $ osapi client node user create --target _all \
## Flags

| Flag | Description | Default |
| -------------- | ----------------------------------------------------------- | ------- |
| `-T, --target` | Target: `_any`, `_all`, hostname, or label (`group:web`) | `_all` |
| `--name` | Username for the new account (required) | |
| `--uid` | Numeric user ID (system assigns if omitted) | |
| `--gid` | Primary group ID (system assigns if omitted) | |
| `--home` | Home directory path | |
| `--shell` | Login shell path | |
| `--groups` | Supplementary groups (comma-separated) | |
| `--password` | Initial password (hashed by the controller before storage) | |
| `--system` | Create a system account | `false` |
| `-j, --json` | Output raw JSON response | |
| -------------- | ---------------------------------------------------------- | ------- |
| `-T, --target` | Target: `_any`, `_all`, hostname, or label (`group:web`) | `_all` |
| `--name` | Username for the new account (required) | |
| `--uid` | Numeric user ID (system assigns if omitted) | |
| `--gid` | Primary group ID (system assigns if omitted) | |
| `--home` | Home directory path | |
| `--shell` | Login shell path | |
| `--groups` | Supplementary groups (comma-separated) | |
| `--password` | Initial password (hashed by the controller before storage) | |
| `--system` | Create a system account | `false` |
| `-j, --json` | Output raw JSON response | |
8 changes: 4 additions & 4 deletions docs/docs/sidebar/usage/cli/client/node/user/password.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ $ osapi client node user password --target _all \

## Flags

| Flag | Description | Default |
| -------------- | ------------------------------------------------------------------ | ------- |
| `-T, --target` | Target: `_any`, `_all`, hostname, or label (`group:web`) | `_all` |
| Flag | Description | Default |
| -------------- | ----------------------------------------------------------------- | ------- |
| `-T, --target` | Target: `_any`, `_all`, hostname, or label (`group:web`) | `_all` |
| `--name` | Username to change password for (required) | |
| `--password` | New password (hashed by the controller before storage) (required) | |
| `-j, --json` | Output raw JSON response | |
| `-j, --json` | Output raw JSON response | |
8 changes: 4 additions & 4 deletions docs/docs/sidebar/usage/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,11 @@ OSAPI uses fine-grained `resource:verb` permissions for access control. Each API
endpoint requires a specific permission. Built-in roles expand to a default set
of permissions:

| Role | Permissions |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Role | Permissions |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `admin` | `agent:read`, `agent:write`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `audit:read`, `command:execute`, `command:shell`, `file:read`, `file:write`, `docker:read`, `docker:write`, `docker:execute`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `power:execute`, `process:read`, `process:execute`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `write` | `agent:read`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `file:read`, `file:write`, `docker:read`, `docker:write`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `process:read`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `read` | `agent:read`, `node:read`, `network:read`, `job:read`, `health:read`, `file:read`, `docker:read`, `cron:read`, `sysctl:read`, `ntp:read`, `timezone:read`, `process:read`, `user:read`, `package:read`, `log:read`, `certificate:read`, `service:read` |
| `write` | `agent:read`, `node:read`, `node:write`, `network:read`, `network:write`, `job:read`, `job:write`, `health:read`, `file:read`, `file:write`, `docker:read`, `docker:write`, `cron:read`, `cron:write`, `sysctl:read`, `sysctl:write`, `ntp:read`, `ntp:write`, `timezone:read`, `timezone:write`, `process:read`, `user:read`, `user:write`, `package:read`, `package:write`, `log:read`, `certificate:read`, `certificate:write`, `service:read`, `service:write` |
| `read` | `agent:read`, `node:read`, `network:read`, `job:read`, `health:read`, `file:read`, `docker:read`, `cron:read`, `sysctl:read`, `ntp:read`, `timezone:read`, `process:read`, `user:read`, `package:read`, `log:read`, `certificate:read`, `service:read` |

### Custom Roles

Expand Down
Loading