Files
2026-08-18 18:34:50 +08:00

1.0 KiB

sidebar_position, sidebar_label, title
sidebar_position sidebar_label title
1 Authentication Authentication

Authentication

Token authentication when the client connects to the server. If the server has no token (or it is empty), authentication is skipped.

When the server enables auth, both sides must use the same token, or login fails. The token is read from the config file. You can also inject it with environment variables; see Environment Variables.

:::tip At login the token is used to compute a digest. The token itself is never sent to the server in plaintext. :::

Example

Server:

# orbien-server.toml
[auth]
token = "YOUR_TOKEN"

Client:

# orbien.toml
[auth]
token = "YOUR_TOKEN"

Parameters

Parameter Required Default Description
auth.token No Shared secret; empty on the server disables auth; both sides must match