changeset 6430:cf5f0a20e16a

mod_rest: Fixup incorrect user auth docs
author Kim Alvefur <zash@zash.se>
date Tue, 10 Mar 2026 16:13:25 +0100
parents 66d7da6a9032
children 459cb2c2789b
files mod_rest/README.md
diffstat 1 files changed, 2 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/mod_rest/README.md	Tue Mar 10 15:38:39 2026 +0100
+++ b/mod_rest/README.md	Tue Mar 10 16:13:25 2026 +0100
@@ -46,24 +46,12 @@
 
 ## User authentication
 
-To enable user authentication, edit the "admins = { }" section in prosody.cfg.lua, EG:
-
-```lua
-admins = { "admin@chat.example.com" }
-```
-
-To set up the admin user account:
-
-```lua
-prosodyctl adduser admin@chat.example.com
-```
-
-and lastly, drop the "@host" from the username in your http queries, EG:
+Usernames are passed via HTTP Basic authentication, _without_ the `@virtualhost` part.
 
 ```lua
 curl -sf \
   -H 'Accept: application/json' \
-  --user admin \
+  --user romeo \
   https://chat.example.com:5281/rest/version/chat.example.com
 ```