Skip to content

fix(docs): align relay systemd install flags with actual CLI #6984

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

Open
Abdul-Moiz31 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(docs): align relay systemd install flags with actual CLI #6984

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51faacf
fix(docs): align relay systemd install flags with actual CLI
Abdul-Moiz31 Jun 23, 2026
3c91ce2
fix(docs): clarify systemd install --token is a machine identity acce…
Abdul-Moiz31 Jun 23, 2026
90aeda3
fix(docs): add required --host and correct AWS-auth systemd guidance
Abdul-Moiz31 Jun 23, 2026
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
19 changes: 16 additions & 3 deletions docs/cli/commands/relay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,12 @@ Relays support two enrollment methods. The enrollment method is set when creatin
```bash
sudo infisical relay systemd install \
--name=<name> \
--enroll-method=token \
--token=<enrollment-token> \
--domain=<your-infisical-domain>
sudo systemctl start infisical-relay
```

`infisical relay systemd install` does not accept `--enroll-method` — it always installs an org-type relay (the default) unless `--type=instance` is passed. See [`infisical relay systemd`](#infisical-relay-systemd) below for its full flag set.
Comment thread
Abdul-Moiz31 marked this conversation as resolved.
Outdated
</Tab>
</Tabs>

Expand All @@ -69,11 +70,13 @@ Relays support two enrollment methods. The enrollment method is set when creatin
```bash
sudo infisical relay systemd install \
--name=<name> \
--enroll-method=aws \
--relay-id=<relay-id> \
--type=instance \
--relay-auth-secret=<relay-auth-secret> \
--domain=<your-infisical-domain>
sudo systemctl start infisical-relay
```

`infisical relay systemd install` does not accept `--enroll-method` or `--relay-id`. AWS-authenticated relays are installed with `--type=instance` and a `--relay-auth-secret` instead. See [`infisical relay systemd`](#infisical-relay-systemd) below for its full flag set.
Comment thread
Abdul-Moiz31 marked this conversation as resolved.
Outdated
</Tab>
</Tabs>

Expand Down Expand Up @@ -121,6 +124,16 @@ Relays support two enrollment methods. The enrollment method is set when creatin
<Accordion title="install">
Install and enable systemd service for the relay. See the authentication section above for install commands.

`install` has its own flag set, distinct from `infisical relay start` — it does **not** accept `--enroll-method` or `--relay-id`:

- `--name` — the name of the relay
- `--type` — `org` (default) or `instance`
- `--token` — machine identity access token, used for `--type=org` (default)
Comment thread
Abdul-Moiz31 marked this conversation as resolved.
- `--relay-auth-secret` — relay auth secret, used for `--type=instance` (or set via env if unset)
- `--host` — the IP or hostname for the relay
Comment thread
Abdul-Moiz31 marked this conversation as resolved.
Outdated
- `--domain` — domain of your self-hosted Infisical instance
- `--log-file` — file to write service logs to (logs aren't written to a file if omitted)

After installation, start the service:

```bash
Expand Down