From ae98610c50bdcbca516e424fd9d51bdf5d3c066b Mon Sep 17 00:00:00 2001 From: strawberry Date: Fri, 30 Aug 2024 15:06:28 -0400 Subject: [PATCH] docs: document new startup `--execute` admin cmd flag/argument Signed-off-by: strawberry --- docs/configuration.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 78646ee3..f4f7f4c7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -31,6 +31,22 @@ string. This does not apply to options that take booleans or numbers: - `--option log=\"debug\"` works ✅ - `--option server_name='"example.com'"` works ✅ +## Execute commandline flag + +conduwuit supports running admin commands on startup using the commandline +argument `--execute`. The most notable use for this is to create an admin user +on first startup. + +The syntax of this is a standard admin command without the prefix such as +`./conduwuit --execute "users create_user june"` + +An example output of a success is: +``` +INFO conduit_service::admin::startup: Startup command #0 completed: +Created user with user_id: @june:girlboss.ceo and password: `` +``` + +This commandline argument can be paired with the `--option` flag. ## Environment variables