Skip to content

Commit f35395d

Browse files
authored
[Feature:System] Add Self Account Creation docs (#657)
Co-authored-by: Barb Cutler <Barb Cutler>
1 parent 6c4e7a0 commit f35395d

File tree

5 files changed

+75
-2
lines changed

5 files changed

+75
-2
lines changed

_docs/instructor/course_management/managing_enrollment.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ Once the user registers for the course, the instructor(s) will receive an email
5454
3. Check the checkbox for `Enable Self Registration`.
5555
4. (Optional) Select the default section you want users to be added to. This defaults to the first section. This can also be edited in the `Manage Sections` page.
5656

57+
A related feature allows new users to make an account on your server.
58+
See also [System Administrator instructions to enable Self Account Creation](/sysadmin/configuration/self_account_creation)
59+
60+
5761
### Add students one-at-a-time
5862

5963
1. Instructors can add students to their course from the "Students"

_docs/student/account/index.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,21 @@ favorite web browser.
1111

1212
![](/images/Login.png)
1313

14-
Have your login credentials ready. (Again, your instructor should
15-
provide this information.) If you have trouble
14+
Have your login credentials ready. Again, your instructor or
15+
university should provide this information. If you have trouble
1616
authenticating/accessing the page, double check the URL and your
1717
username and password, and contact the instructor, TA, or system
1818
administrator as appropriate.
1919

20+
If your school allows for users to create their own accounts, your
21+
login page will include a button "New to Submitty? Sign up now!".
22+
23+
![](/images/Login_self_account_creation.png)
24+
25+
Click that button and follow the instructions to specify your email address,
26+
given name, family name, and choose your Submitty User ID and Password.
27+
28+
2029

2130
## My Courses
2231

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
category: System Administrator > Configuration & Administration
3+
title: Self Account Creation
4+
---
5+
6+
The feature of User Account Creation (a.k.a. Self Account Creation) is
7+
only available on systems that use DatabaseAuthentication.
8+
9+
To change authentication types, either re-run `CONFIGURE_SUBMITTY.py`
10+
or manually edit `/usr/local/submitty/config/authentication.json` and
11+
change the authentication method to `DatabaseAuthentication`.
12+
13+
See also [Managing Enrollment](/instructor/course_management/managing_enrollment)
14+
15+
16+
### Enable Self Account Creation
17+
18+
To enable self account creation if you already have a Submitty instance setup, manually edit the
19+
`/usr/local/submitty/config/submitty.json` configuration file. By
20+
default, `user_create_account` is set to `false`. To enable it, change
21+
this to `true`. You will also need to add configuration settings for
22+
`"user_id_requirements"`:
23+
24+
25+
```json
26+
"user_create_account": true,
27+
"user_id_requirements": {
28+
"any_user_id": true,
29+
"require_name": false,
30+
"min_length": 6,
31+
"max_length": 25,
32+
"name_requirements": {
33+
"given_first": false,
34+
"given_name": 2,
35+
"family_name": 4
36+
},
37+
"require_email": false,
38+
"email_requirements": {
39+
"whole_email": false,
40+
"whole_prefix": false,
41+
"prefix_count": 6
42+
},
43+
"accepted_emails": [
44+
"gmail.com"
45+
]
46+
}
47+
```
48+
49+
50+
### Email and User ID Requirements
51+
52+
53+
* If `require_name` is true, then the `user_id` must start with and contain a
54+
certain amount of characters from the given name and/or family name.
55+
56+
* If the user does not have the character amount for the given part of the name, it will accept shorter usernames. (e.g. James Wo -> woja, and James Joseph -> joseja)
57+
58+
* `given_first` determines whether the given name or family name must come first. (e.g. Test User -> userte vs teuser)
59+
151 KB
Loading

navtreedata.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ var NAVTREE =
179179
[ "Course Creation", "/sysadmin/configuration/course_creation", null ],
180180
[ "Ansible Course Creation", "/sysadmin/configuration/ansible_course_creation", null ],
181181
[ "Setting up Version Control", "/sysadmin/configuration/version_control", null ],
182+
[ "Self Account Creation", "/sysadmin/configuration/self_account_creation", null ],
182183
[ "SAML Authentication", "/sysadmin/configuration/saml_authentication", null ],
183184
[ "Email Configuration", "/sysadmin/configuration/email_configuration", null ],
184185
[ "Registration Feed", "/sysadmin/configuration/registration_feed", null ],

0 commit comments

Comments
 (0)