# Reference: server.admin

URL: https://scalws.com/docs/reference/server-admin/
Source: `docs/reference/schema` in the ScalWS repository

<h3 id="server.admin.enabled"><code>server.admin.enabled</code></h3>

| | |
|---|---|
| Syntax | `enabled: true \| false` |
| Default | `true on Unix` |
| Context | `server.admin` |
| Reload | needs a restart |

Default: true on Unix.


<h3 id="server.admin.remote"><code>server.admin.remote</code></h3>

| | |
|---|---|
| Syntax | `remote: {...}` |
| Default | `none` |
| Context | `server.admin` |
| Reload | adding or removing it needs a restart; its values apply on reload |

Remote administration over TCP with mutual TLS (ADR-0023); off unless set.


<h3 id="server.admin.remote.address"><code>server.admin.remote.address</code></h3>

| | |
|---|---|
| Syntax | `address: <string>` |
| Default | `required` |
| Context | `server.admin.remote` |
| Reload | needs a restart |

Address of the remote admin listener (mutual TLS).


<h3 id="server.admin.remote.cert"><code>server.admin.remote.cert</code></h3>

| | |
|---|---|
| Syntax | `cert: <string>` |
| Default | `required` |
| Context | `server.admin.remote` |
| Reload | needs a restart |

Server certificate chain (PEM) and key.


<h3 id="server.admin.remote.client_ca"><code>server.admin.remote.client_ca</code></h3>

| | |
|---|---|
| Syntax | `client_ca: <string>` |
| Default | `required` |
| Context | `server.admin.remote` |
| Reload | needs a restart |

CA (PEM) that issued the operators' client certificates; required.


<h3 id="server.admin.remote.key"><code>server.admin.remote.key</code></h3>

| | |
|---|---|
| Syntax | `key: <string>` |
| Default | `required` |
| Context | `server.admin.remote` |
| Reload | needs a restart |

Private key (PEM) of the remote admin listener.


<h3 id="server.admin.socket"><code>server.admin.socket</code></h3>

| | |
|---|---|
| Syntax | `socket: <string>` |
| Default | `<runtime_dir>/admin.sock` |
| Context | `server.admin` |
| Reload | needs a restart |

Default: `<runtime_dir>/admin.sock`.