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.

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

[Feature:System] Add Self Account Creation docs #657

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
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: 7 additions & 0 deletions _docs/student/account/self_account_creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
category: Student > Courses & Profile
title: Self Account Creation
---


##
47 changes: 47 additions & 0 deletions _docs/sysadmin/configuration/self_account_creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
category: Student > Courses & Profile
title: Self Account Creation
---

### Enable Self Account Creation

Currently the only way to enable users to create their own accounts is to manually edit the submitty.json configuration file. The default location for this
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`.

### Email and User ID Requirements

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

* 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.

* If the user does not have the character amount for the given part of the name, then !add fix!

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

```json
"user_id_requirements": {
"all": true,
"require_name": false,
"min_length": 6,
"max_length": 25,
"name_requirements": {
"given_first": false,
"given_name": 2,
"family_name": 4
},
"require_email": false,
"email_requirements": {
"whole_email": false,
"whole_prefix": false,
"prefix_count": 6
}
}
```

```json
"accepted_emails": {
"gmail.com": true,
"rpi.edu": true
}
```
1 change: 1 addition & 0 deletions navtreedata.js
Original file line number Diff line number Diff line change
@@ -174,6 +174,7 @@ var NAVTREE =
[ "Course Creation", "/sysadmin/configuration/course_creation", null ],
[ "Ansible Course Creation", "/sysadmin/configuration/ansible_course_creation", null ],
[ "Setting up Version Control", "/sysadmin/configuration/version_control", null ],
[ "Self Account Creation", "/sysadmin/configuration/self_account_creation", null ],
[ "SAML Authentication", "/sysadmin/configuration/saml_authentication", null ],
[ "Email Configuration", "/sysadmin/configuration/email_configuration", null ],
[ "Registration Feed", "/sysadmin/configuration/registration_feed", null ],