mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-28 11:36:44 +00:00
Add documentation about user management (#8321)
This commit is contained in:
parent
90f726e325
commit
e219b7c914
49
docs/docs/start/accounts.md
Normal file
49
docs/docs/start/accounts.md
Normal file
@ -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 <username>
|
||||
```
|
||||
|
||||
The system will prompt you to enter a new password for the specified user account.
|
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user