From b3084aee9661f2c0550848074c30e35995716b45 Mon Sep 17 00:00:00 2001 From: Sebastian Jeltsch Date: Wed, 24 Sep 2025 22:14:49 +0200 Subject: [PATCH] Add auth UI installation to getting started sections. --- README.md | 14 ++++++++++++-- docs/src/content/docs/getting-started/install.mdx | 15 ++++++++++++++- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9a07b091..e617a3b6 100644 --- a/README.md +++ b/README.md @@ -127,8 +127,18 @@ trail run On first start, a `./traildepot` folder will be bootstrapped, an admin user created and their credentials printed to the terminal. -Afterwards open http://localhost:4000/_/admin/ in your browser and use the -credentials to log into the admin dashboard. +Afterwards open [http://localhost:4000/\_/admin/](http://localhost:4000/_/admin/) +in your browser and use the credentials to log into the admin dashboard. + +If you want to install the auth UI, you can simply run: + +```sh +trail components add trailbase/auth_ui +``` + +, which will add a WASM component in `./traildepot/wasm` exposing additional UI +endpoints, e.g. +[http://localhost:4000/\_/auth/login](http://localhost:4000/_/auth/login). ## Building diff --git a/docs/src/content/docs/getting-started/install.mdx b/docs/src/content/docs/getting-started/install.mdx index 7c80d0fc..4b618959 100644 --- a/docs/src/content/docs/getting-started/install.mdx +++ b/docs/src/content/docs/getting-started/install.mdx @@ -29,6 +29,15 @@ Once installed, you can run to check that the executable is properly installed and list all available command line options. +## Optional Auth UI + +If you want to install the auth UI, you can simply run: + +```sh +trail components add trailbase/auth_ui +``` + +, which will add a WASM component exposing additional UI endpoints. ## Starting the Server & Admin Dashboard @@ -61,7 +70,8 @@ trail user change-email admin@localhost me@mydomain.org Don't worry about breaking anything, you can always delete `traildepot` and start from scratch. -Armed with your new credentials, open http://localhost:4000/_/admin/ in your +Armed with your new credentials, open +[http://localhost:4000/_/admin/](http://localhost:4000/_/admin/) in your browser and log in. We encourage you to take a few minutes, click around, and maybe create a table @@ -71,6 +81,9 @@ schema migration file will be created in `traildepot/migrations`. This allows TrailBase to enforce consistent schemas across multiple database instances for dev, test, prod, ... . +If you installed the auth UI above, feel free to also explore +[http://localhost:4000/_/auth/login](http://localhost:4000/_/auth/login). + If you like what you see and want to get your hands dirty, consider checking out some of the tutorials. Lastly, if you have any issues or feedback, don't hesitate and reach out either