Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some incorrect documents in multiuser doc #640

Closed
wants to merge 5 commits into from
Closed

Fix some incorrect documents in multiuser doc #640

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
75084a5
Fix typo in the SQL in multiuser doc
kngwyu Jun 18, 2024
50e8b72
Fix the doc more
kngwyu Jun 18, 2024
f693d8c
Spell
kngwyu Jun 18, 2024
89d2824
Use editable install in the multiuser instruction
kngwyu Jun 24, 2024
7e3e891
Remove unintentionally added .
kngwyu Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/host_for_multiuser/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Follow the steps below to setup `multiuser` mode.
1. Install backend requirements
```bash
cd studio
pip install .
pip install -e .
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pip install . installs the packages into site-packages under the anaconda env without copying the config modified in the previous sections. So we need to use editable install or put config files under site-packages.

```
2. Setup database
```bash
Expand All @@ -133,10 +133,11 @@ Follow the steps below to setup `multiuser` mode.
USE YOUR_DATABASE_NAME;
INSERT INTO organization (name) VALUES ('YOUR_ORGANIZATION_NAME');
INSERT INTO roles (id, role) VALUES (1, 'admin'), (20, 'operator');
INSERT INTO users (uid, organization_id, name, email, active, ) VALUES ('USER_UID', 1, 'YOUR_EMAIL', 'YOUR_PASSWORD', 1);
INSERT INTO users (uid, organization_id, name, email, active) VALUES ('YOUR_UID', 1, 'YOUR_NAME', 'YOUR_EMAIL', 1);
INSERT INTO user_roles (user_id, role_id) VALUES (1, 1);
```
- USER_UID is the user uid you created in the previous step ([Create admin user for the project](#create-admin-user-for-the-project)).
- YOUR_UID and YOUR_EMAIL should be ones you set in the previous step ([Create admin user for the project](#create-admin-user-for-the-project)).
- YOUR_NAME and YOUR_ORGANIZATION_NAME can be arbitrary.
- Only 2 roles, "admin" and "operator" are supported for now.
- "admin"
- can manage other users
Expand Down