From e219b7c914824c704c6e8de7487663c44c5db266 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 21 Oct 2024 10:05:23 +1100 Subject: [PATCH] Add documentation about user management (#8321) --- docs/docs/start/accounts.md | 49 +++++++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 1 + 2 files changed, 50 insertions(+) create mode 100644 docs/docs/start/accounts.md diff --git a/docs/docs/start/accounts.md b/docs/docs/start/accounts.md new file mode 100644 index 0000000000..4722f35ebd --- /dev/null +++ b/docs/docs/start/accounts.md @@ -0,0 +1,49 @@ +--- +title: Account Management +--- + +## User Accounts + +By default, InvenTree does not ship with any user accounts. Configuring user accounts is the first step to login to the InvenTree server. + +### Administrator Account + +You can configure InvenTree to create an administrator account on the first run. This account will have full *superuser* access to the InvenTree server. + +This account is created when you first run the InvenTree server instance. The username / password for this account can be configured in the configuration file, or environment variables. + +!!! info "More Information" + For more information on configuring the administrator account, refer to the [configuration documentation](./config.md#administrator-account). + +### Create Superuser + +Another way to create an administrator account is to use the `superuser` command. This will create a new superuser account with the specified username and password. + +```bash +invoke superuser +``` + +Or, if you are running InvenTree in a Docker container: + +```bash +docker exec -rm -it inventree-server invoke superuser +``` + +### User Management + +Once you have created an administrator account, you can create and manage additional user accounts from the InvenTree web interface. + +## Password Management + +### Reset Password via Command Line + +If a password has been lost, and other backup options (such as email recovery) are unavailable, the system administrator can reset the password for a user account from the command line. + +Log into the machine running the InvenTree server, and run the following command (from the top-level source directory): + +```bash +cd src/backend/InvenTree +python ./manage.py changepassword +``` + +The system will prompt you to enter a new password for the specified user account. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b9d4fdd137..99c49b4dd8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -98,6 +98,7 @@ nav: - Production: start/bare_prod.md - Development: start/bare_dev.md - Serving Files: start/serving_files.md + - User Accounts: start/accounts.md - Data Backup: start/backup.md - Migrating Data: start/migrate.md - Advanced Topics: start/advanced.md