diff --git a/docs/guide/admin_ui.md b/docs/guide/admin_ui.md index 27d11609..f71019a2 100644 --- a/docs/guide/admin_ui.md +++ b/docs/guide/admin_ui.md @@ -18,7 +18,9 @@ nav_order: 1 # LNBits Admin UI -We introduced the Admin UI as the new default to make setup simpler and more straightforward. Instead of hand editing the `.env` file, you configure key server settings directly in the frontend with clear labels and guardrails. +[What you can do](#what-you-can-do-with-the-admin-ui) · [First Run](#first-run-and-super-user-id) · [Enable/Disable](#enabling-or-disabling-the-admin-ui) · [Reset](#reset-to-defaults) · [Allowed Users](#allowed-users) · [Guides](#additional-guides) + +**We introduced the Admin UI as the new default to make setup simpler and more straightforward**. Instead of hand editing the `.env` file, you configure key server settings directly in the frontend with clear labels and guardrails. On a fresh install the Admin UI is enabled by default, and at first launch you are prompted to create **Super User** credentials so that sensitive operations, such as switching funding sources, remain in trusted hands. When the Admin UI is enabled, configuration is written to and read from the database; for all settings managed by the UI, the parameters in `.env` are largely no longer used. If you disable the Admin UI, the `.env` file becomes the single source of truth again. @@ -42,6 +44,27 @@ For a complete reference of legacy variables consult **[.env.example](../../.env > [!NOTE] > See **[Super User](./super_user.md)** for the role and permission differences compared to Admin Users. +## First run and Super User ID + +On first start with the Admin UI enabled you will be prompted to generate a Super User. + +Admin_UI_first_install + +If you need to read it from disk later: + +```bash +cat /lnbits/data/.super_user +# example +123de4bfdddddbbeb48c8bc8382fe123 +``` + +> [!WARNING] +> For security reasons, Super Users and Admin users must authenticate with credentials (username and password). + +After login you will see **Settings** and **Users** in the sidebar between **Wallets** and **Extensions**, plus a role badge in the top left. + +grafik + ## Enabling or disabling the Admin UI The Admin UI is enabled by default on new installs. To change the state: @@ -82,23 +105,6 @@ The Admin UI is enabled by default on new installs. To change the state: Using `Reset to defaults` in the Admin UI wipes stored settings. After a restart, a new `Super User` is created and the old one is no longer valid. -## First run and Super User ID - -On first start with the Admin UI enabled you will be prompted to generate a Super User. If you need to read it from disk later: - -```bash -cat /lnbits/data/.super_user -# example -123de4bfdddddbbeb48c8bc8382fe123 -``` - -> [!WARNING] -> For security reasons, Super Users and Admin users must authenticate with credentials (username and password). - -After login you will see **Settings** and **Users** in the sidebar between **Wallets** and **Extensions**, plus a role badge in the top left. - -grafik - ## Allowed Users When set **at least one**, LNbits becomes private: only the listed users and Admins can access the frontend. Account creation is disabled automatically. You can also disable account creation explicitly. @@ -111,8 +117,8 @@ When set **at least one**, LNbits becomes private: only the listed users and Adm ## Additional Guides - **[Backend Wallets](./wallets.md)** — Explore options to fund your LNbits instance. -- **[User Roles](./User_Roles.md)** — Overview of existing roles in LNbits. -- **[Funding sources](./funding-sources_table.md)** — What is available and how to configure each. +- **[User Roles](./user_roles.md)** — Overview of existing roles in LNbits. +- **[Funding sources](./funding-sources-table.md)** — What is available and how to configure each. - **[Install LNBits](./installation.md)** — Choose your prefared way to install LNBits. ## Powered by LNbits diff --git a/docs/guide/super_user.md b/docs/guide/super_user.md index 837ccca2..f7b0db18 100644 --- a/docs/guide/super_user.md +++ b/docs/guide/super_user.md @@ -116,8 +116,8 @@ These are practical tips for running a safe and friendly instance. ## Additional guides - **[Admin UI](./admin_ui.md)** — Manage server settings in the browser instead of editing `.env` or using the CLI for routine tasks. -- **[User Roles](./User_Roles.md)** — Overview of roles and what they can do. -- **[Funding sources](./funding-sources_table.md)** — Available options and how to enable and configure them. +- **[User Roles](./user_roles.md)** — Overview of roles and what they can do. +- **[Funding sources](./funding-sources-table.md)** — Available options and how to enable and configure them. - **[Install LNBits](./installation.md)** — Choose your prefared way to install LNBits. ## Powered by LNbits diff --git a/docs/guide/user_roles.md b/docs/guide/user_roles.md index 97821fb7..39b42442 100644 --- a/docs/guide/user_roles.md +++ b/docs/guide/user_roles.md @@ -87,7 +87,7 @@ For using LNbits, not administering it. - **[Admin UI](./admin_ui.md)** — Manage server settings via a clean UI (avoid editing `.env` by hand). - **[Super User](./super_user.md)** — Deep dive on responsibilities and safe usage patterns. -- **[Funding sources](./funding-sources_table.md)** — What’s available and how to enable/configure each. +- **[Funding sources](./funding-sources-table.md)** — What’s available and how to enable/configure each. ## Powered by LNbits diff --git a/docs/guide/wallets.md b/docs/guide/wallets.md index d1059a57..51275a5e 100644 --- a/docs/guide/wallets.md +++ b/docs/guide/wallets.md @@ -354,8 +354,8 @@ Get more info here [https://docs.strike.me/strike-oauth-connect/](https://docs.s ## Additional Guides - **[Admin UI](./admin_ui.md)** — Manage server settings via a clean UI (avoid editing `.env` by hand). -- **[User Roles](./User_Roles.md)** — Quick Overview of existing Roles in LNBits. -- **[Funding sources](./funding-sources_table.md)** — What’s available and how to enable/configure each. +- **[User Roles](./user_roles.md)** — Quick Overview of existing Roles in LNBits. +- **[Funding sources](./funding-sources-table.md)** — What’s available and how to enable/configure each. ## Powered by LNbits diff --git a/package.json b/package.json index 47c207a5..c7887ffd 100644 --- a/package.json +++ b/package.json @@ -23,10 +23,10 @@ "axios": "^1.12.0", "chart.js": "^4.4.4", "moment": "^2.30.1", + "nostr-tools": "^2.7.2", "qrcode.vue": "^3.4.1", "quasar": "2.17.0", "showdown": "^2.1.0", - "nostr-tools": "^2.7.2", "underscore": "^1.13.7", "vue": "3.5.8", "vue-i18n": "^10.0.8",