docs/multiuser/user_guide.md
Multi-User mode is a recent feature (introduced in version 6.12), which allows multiple individuals to share a single InvokeAI server while keeping their work separate and organized. Each user has their own username and login password, images, assets, image boards, customization settings and workflows.
Two types of users are recognized:
Multiple users can be granted Administrator status.
To activate Multi-User mode, open the INVOKEAI_ROOT/invokeai.yaml configuration file in a text editor. Add this line anywhere in the file:
multiuser: true
You may also wish to make InvokeAI available to other machines on your local LAN. Add an additional line to invokeai.yaml:
host: 0.0.0.0
Restart the server. It will now be in multi-user mode. If you enabled
the host option, other users on your home or office LAN will be able
to reach it by browsing to the IP address of the machine the backend
is running on (http://host-ip-address:9090).
!!! tip "Do not expose InvokeAI to the internet" It is not recommended to expose the InvokeAI host to the internet due to security concerns.
If you're the first person to access a fresh InvokeAI installation in multi-user mode, you'll see the Administrator Setup dialog:
Now
You'll now be taken to a login screen and can enter the credentials you just created.
If you are logged in as Administrator, you can add additional users. Click on the small "person silhouette" icon at the bottom left of the main Invoke screen and select "User Management:"
This will take you to the User Management screen...
...where you can click "Create User" to add a new user.
The User Management screen also allows you to:
Administrators can also use a series of command-line scripts to add, modify, or delete users. If you use the launcher, click the ">" icon to enter the command-line interface. Otherwise, if you are a native command-line user, activate the InvokeAI environment from your terminal.
The commands are named:
Pass the --help argument to get the usage of each script. For example:
> invoke-useradd --help
usage: invoke-useradd [-h] [--root ROOT] [--email EMAIL] [--password PASSWORD] [--name NAME] [--admin]
Add a user to the InvokeAI database
options:
-h, --help show this help message and exit
--root ROOT, -r ROOT Path to the InvokeAI root directory. If omitted, the root is resolved in this order: the $INVOKEAI_ROOT environment
variable, the active virtual environment's parent directory, or $HOME/invokeai.
--email EMAIL, -e EMAIL
User email address
--password PASSWORD, -p PASSWORD
User password
--name NAME, -n NAME User display name (optional)
--admin, -a Make user an administrator
If no arguments are provided, the script will run in interactive mode.
If you are a registered user on the system, enter your email address and password to log in. The Administrator will be able to provide you with the values to use:
As an unprivileged user you can do pretty much anything that's allowed under single-user mode -- generating images, using LoRAs, creating and running workflows, creating image boards -- but you are restricted against installing new models, changing low-level server settings, or interfering with other users. More information on user roles is given below.
To change your display name or profile, click on the person silhouette icon at the bottom left of the screen and choose "My Profile". This will take you to a screen that lets you change these values. At this time you can change your display name but not your login ID (ordinarily your contact email address).
In single-user mode, you have access to all features without restrictions. In multi-user mode, InvokeAI has two user roles:
As a regular user, you can:
You cannot:
!!! tip "The generation queue" When two or more users are accessing InvokeAI at the same time, their image generation jobs will be placed on the session queue on a first-come, first-serve basis. This means that you will have to wait for other users' image rendering jobs to complete before yours will start.
When another user's job is running, you will see the image
generation progress bar and a queue badge that reads `X/Y`, where
"X" is the number of jobs you have queued and "Y" is the total
number of jobs queued, including your own and others.
You can also pull up the Queue tab in order to see where your job
is in relationship to other queued tasks.
Administrators have all regular user capabilities, plus:
In multi-user model, Image Boards work as before. Each user can create an unlimited number of boards and organize their images and assets as they see fit. Boards are private: you cannot see a board owned by a different user.
!!! tip "Shared Boards" InvokeAI 6.13 will add support for creating public boards that are accessible to all users.
The Administrator can see all users Image Boards and their contents.
If an InvokeAI instance was in multiuser mode and then restarted in single user mode (by setting multiuser: false in the configuration file), all users' boards will be consolidated in one place. Any images that were in "Uncategorized" will be merged together into a single Uncategorized board. If, at a later date, the server is restarted in multi-user mode, the boards and images will be separated and restored to their owners.
In the current released version (6.12) workflows are always shared among users. Any workflow that you create will be visible to other users and vice-versa, and there is no protection against one user modifying another user's workflow.
!!! tip "Private and Shared Workflows" InvokeAI 6.13 will provide the ability to create private and shared workflows. A private workflow can only be viewed by the user who created it. At any time, however, the user can designate the workflow shared, in which case it can be opened on a read-only basis by all logged-in users.
The queue shows your pending and running generation tasks.
Queue Features:
Queue Isolation:
Your UI preferences are saved to your account and are restored when you log in:
These settings are stored per-user and won't affect other users.
Issue: Login fails with "Incorrect email or password"
Solutions:
Issue: Login fails with "Account is disabled"
Solution: Contact your administrator to reactivate your account
Issue: You're suddenly logged out and see "Session expired"
Explanation: Sessions expire after 24 hours (or 7 days with "remember me")
Solution: Simply log in again with your credentials
Issue: Features like Model Manager show "Admin privileges required"
Explanation: Some features are restricted to administrators
Solution:
Issue: Boards or images you created are not visible
Possible Causes:
Solution:
Issue: Generation or UI feels slower than expected
Possible Causes:
Solutions:
Issue: Your generation is queued but not starting
Possible Causes:
Solutions:
No, unless you add them to a shared board (FUTURE FEATURE). All your personal boards and images are private.
Not directly. Ask your administrator to mark workflows as public if you want to share them.
Yes, but you'll need to authenticate with a JWT token. See the API Guide for details.
Contact your administrator. They can reset your password for you.
Yes, you can log in from multiple devices or browsers simultaneously. All sessions will use the same account and see the same content.
Regular users can see the Models tab but with read-only access. Check that you're logged in and try refreshing the page.
Administrators see an "Admin" badge next to their name in the top-right corner and have access to additional features like User Management.
Yes, ask your current administrator to grant you admin privileges. Admin privileges will give you the ability to see all other user's boards and images, as well as to add models and change various server-wide settings.
When reporting an issue, include:
Need more help? Contact your administrator or visit the InvokeAI Discord.