From 3855bfa3164154cd78ef4cc60e32de105a634fff Mon Sep 17 00:00:00 2001 From: IDzyre Date: Thu, 29 Aug 2024 13:32:25 -0800 Subject: [PATCH] Initial work --- .../student/account/self_account_creation.md | 7 +++ .../configuration/self_account_creation.md | 47 +++++++++++++++++++ navtreedata.js | 1 + 3 files changed, 55 insertions(+) create mode 100644 _docs/student/account/self_account_creation.md create mode 100644 _docs/sysadmin/configuration/self_account_creation.md diff --git a/_docs/student/account/self_account_creation.md b/_docs/student/account/self_account_creation.md new file mode 100644 index 00000000..0e1cdea3 --- /dev/null +++ b/_docs/student/account/self_account_creation.md @@ -0,0 +1,7 @@ +--- +category: Student > Courses & Profile +title: Self Account Creation +--- + + +## \ No newline at end of file diff --git a/_docs/sysadmin/configuration/self_account_creation.md b/_docs/sysadmin/configuration/self_account_creation.md new file mode 100644 index 00000000..bd66da4d --- /dev/null +++ b/_docs/sysadmin/configuration/self_account_creation.md @@ -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 +} +``` \ No newline at end of file diff --git a/navtreedata.js b/navtreedata.js index 898e0785..33607a26 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -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 ],