From 7bb004cf50fd242025ba958884b1718e8a5e7749 Mon Sep 17 00:00:00 2001 From: Owen Date: Mon, 29 Dec 2025 22:15:01 -0500 Subject: [PATCH] Update docs Former-commit-id: 543ca05eb9a9ea8a2ab087b6110dd0c011973510 --- API.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/API.md b/API.md index 4e20f50..dc2f7ff 100644 --- a/API.md +++ b/API.md @@ -1,10 +1,10 @@ -## HTTP API +## API -Olm can be controlled with an embedded HTTP server when using `--enable-http`. This allows you to start it as a daemon and trigger it with the following endpoints. The API can listen on either a TCP address or a Unix socket/Windows named pipe. +Olm can be controlled with an embedded API server when using `--enable-api`. This allows you to start it as a daemon and trigger it with the following endpoints. The API can listen on either a TCP address or a Unix socket/Windows named pipe. ### Socket vs TCP -By default, when `--enable-http` is used, Olm listens on a TCP address (configured via `--http-addr`, default `:9452`). Alternatively, Olm can listen on a Unix socket (Linux/macOS) or Windows named pipe for local-only communication with better security. +When `--enable-api` is used, Olm can listen on a TCP address when configured via `--http-addr` (like `:9452`). Alternatively, Olm can listen on a Unix socket (Linux/macOS) or Windows named pipe for local-only communication with better security when using `--socket-path` (like `/var/run/olm.sock`). **Unix Socket (Linux/macOS):** - Socket path example: `/var/run/olm/olm.sock`