Skip to content

Commit 4c22b1a

Browse files
Barb CutlerBarb Cutler
authored andcommitted
revise writeup
1 parent fb5fcd4 commit 4c22b1a

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed
Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
---
2-
category: Student > Courses & Profile
2+
category: System Administrator > Configuration & Administration
33
title: Self Account Creation
44
---
55

6-
### Enable Self Account Creation
6+
The feature of User Account Creation (a.k.a. Self Account Creation) is
7+
only available on systems that use DatabaseAuthentication.
78

8-
There are two steps to enable self account creation, Firstly you have to manually edit the submitty.json configuration file. The default location for this
9-
file is `/usr/local/submitty/config/submitty.json`. By default, `self_account_creation_allowed` is set to `false`. To enable it, change this to `true`. Secondly,
10-
you have to be using DatabaseAuthentication. To change authentication types, either re-run CONFIGURE_SUBMITTY.py or edit /usr/local/submitty/config/authentication.json and change the authentication method to any of the methods. You should be able to leave all other settings to the default.
11-
*Warning* This will disallow all users who are not in the database from being able to login, so this should only be used if you are only using database authentication.
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`.
1212

13-
### Email and User ID Requirements
13+
See also [Managing Enrollment](/instructor/course_management/managing_enrollment)
1414

15-
Below are the current accepted requirements for user_ids.
16-
* If `all` is set to `true`, then `length` parameters are the only parameters checked.
1715

18-
* If `require_name` is true, then the user_id must start with and contain a certain amount of characters from the given name and/or family name.
16+
### Enable Self Account Creation
1917

20-
* If the user does not have the character amount for the given part of the name, then !add fix!
18+
To enable self account creation, manually edit the
19+
`/usr/locl/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"`:
2123

22-
* `given_first` determines whether the given name or family name must come first. (e.g. Test User -> userte vs teuser)
2324

2425
```json
26+
"user_create_account": true,
2527
"user_id_requirements": {
26-
"all": true,
28+
"any_user_id": true,
2729
"require_name": false,
2830
"min_length": 6,
2931
"max_length": 25,
@@ -37,13 +39,21 @@ Below are the current accepted requirements for user_ids.
3739
"whole_email": false,
3840
"whole_prefix": false,
3941
"prefix_count": 6
40-
}
42+
},
43+
"accepted_emails": [
44+
"gmail.com"
45+
]
4146
}
4247
```
4348

44-
```json
45-
"accepted_emails": {
46-
"gmail.com": true,
47-
"rpi.edu": true
48-
}
49-
```
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, then !add fix!
57+
58+
* `given_first` determines whether the given name or family name must come first. (e.g. Test User -> userte vs teuser)
59+

0 commit comments

Comments
 (0)