Refactor documentation for install

Removes CONFIGURE_SUBMTITY references, adds instructiosn to edit files

Author: IDzyre

_docs/developer/development_instructions/automated_grading.md

@@ -60,7 +60,7 @@ number:
    ```
 
    _NOTE: If you delete the `autograding_workers.json` file and re-run
-   `CONFIGURE_SUBMITTY.py`, the file will be re-created with the
+   `generate_configs.py`, the file will be re-created with the
    default settings._
 
 ---

_docs/developer/development_instructions/index.md

@@ -207,17 +207,10 @@ autograding configuration, you'll probably need to:
 ## System Re-Configuration
 
 If recent development changes include modifications to files affecting
-the system installation process (e.g., changes to
-`CONFIGURE_SUBMITTY.py`, `install_system.sh`, `Vagrantfile`), you will
+the system installation process (e.g., changes to `install_system.sh` or `Vagrantfile`), you will
 need to either re-provision or re-build your VM from scratch to test
 these changes.
 
-* To re-run the initial configuration step of Submitty, use this command:
-
-  ```
-  sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py
-  ```
-
 * To update existing databases:
 
   ```

_docs/developer/development_instructions/miscellaneous.md

@@ -9,7 +9,7 @@ category: Developer > Development Instructions
 Our vagrant environment defaults to PAM authentication, but is also
 setup to easily use any of the other supported authentication methods.
 
-To switch, either re-run CONFIGURE_SUBMITTY.py or edit
+To switch, 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.
@@ -29,7 +29,6 @@ For `LdapAuthentication`, the default settings are:
 When using DatabaseAuthentication, Submitty allows users to
 [change their password](/student/account/password) from the home screen.
 
-
 #### SAML
 
 To easily setup SAML authentication locally: You can run the following

_docs/sysadmin/configuration/email_configuration.md

@@ -30,10 +30,7 @@ First, the Submitty server must be configured to send email:
    (currently set to send a maximum of 100 email messages per minute).   
 
 
-2. Run `sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py` and enter each email field.
-
-   `/usr/local/submitty/config/email.json` should now contain:
-
+2. Edit `/usr/local/submitty/config/email.json`, and add your specific values.
     ```
     {
       "email_enabled": true,

_docs/sysadmin/configuration/rainbow_grades.md

@@ -12,7 +12,7 @@ Submitty includes the ability for instructors to automatically generate rainbow
 For this feature to work correctly:
 
 1. The ```<submitty install dir>/config/submitty_admin.json``` file must contain credentials for a submitty admin user. 
-Usually this file will be configured automatically as part of the inputs for the ```CONFIGURE_SUBMITTY.py``` script.  The 
+This file will be generated automatically as part of the inputs for the ```generate_configs.py``` script. You must edit that file to add your Submitty admin user. The 
 credentials in this file are for a submitty *course* user, not a *linux* user.
 
 1. The submitty admin user must exist as an instructor of the course for which the rainbow grades are going to be automatically

_docs/sysadmin/configuration/saml_authentication.md

@@ -90,29 +90,13 @@ To configure your system:
       attribute is the field from the return object that contains the
       user's username.
 
-    * Re-run `CONFIGURE_SUBMITTY.py` to enable SAML, specify the SAML
-      username attribute, and customize login message.
-
-      ```
-      python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py
-      ```
-
-      You can press `return` to keep the current settings for most of
-      the settings, except:
-
-      ```
-      What authentication method to use:
-      1. PamAuthentication
-      2. DatabaseAuthentication
-      3. LdapAuthentication
-      4. SamlAuthentication
-      Enter number?: [1] 4
-
-      Enter name you would like shown to user for authentication?: <YOUR CUSTOM MESSAGE E.g., "Login with your University ID via Duo">
-
-      Enter SAML username attribute?:  <ENTER THE SAML username attribute>
-      ```
-
+    * Edit `/<submitty install dir>/config/authentication.json` to add your information.
+    ```json
+      "saml_options": {
+      "name": "",
+      "username_attribute": ""
+    }
+  ```
     * Reinstall Submitty, run:
 
       ```
@@ -280,7 +264,7 @@ To configure your system:
       TRUNCATE TABLE sessions;
       ```
 
-    * Or, by running CONFIGURE_SUBMITTY.py. It will clear the jwt secret
+    * Or, by running generate_configs.py. It will clear the jwt secret
       and invalidate all current sessions.
 
 

_docs/sysadmin/configuration/self_account_creation.md

@@ -6,8 +6,7 @@ title: Self Account Creation
 The feature of User Account Creation (a.k.a. Self Account Creation) is
 only available on systems that use DatabaseAuthentication.
 
-To change authentication types, either re-run `CONFIGURE_SUBMITTY.py`
-or manually edit `/usr/local/submitty/config/authentication.json` and
+To change authentication types, manually edit `/usr/local/submitty/config/authentication.json` and
 change the authentication method to `DatabaseAuthentication`.
 
 See also [Managing Enrollment](/instructor/course_management/managing_enrollment)

_docs/sysadmin/installation/index.md

@@ -34,7 +34,7 @@ You can use these [instructions](/sysadmin/installation/ansible).
    synchronize `/etc/passwd`, `/etc/shadow`, `/etc/group`, and `/etc/gshadow` before installing
    the rest of Submitty to avoid mismatched UIDs and GIDs of the Submitty users.
 
-2. Run the bootstrap script:
+1. Run the bootstrap script:
    ```
    bash -c "$(curl -s https://raw.githubusercontent.com/Submitty/Submitty/master/.setup/bootstrap.sh)"
    ```
@@ -48,31 +48,68 @@ You can use these [instructions](/sysadmin/installation/ansible).
    bash ./.setup/install_system.sh
    ```
 
-   Note: During installation, you will be asked several questions by the
-   [CONFIGURE_SUBMITTY.py](https://github.com/Submitty/Submitty/blob/master/.setup/CONFIGURE_SUBMITTY.py)
-   script. Pressing enter will select the default option. These questions are:
-   1. **Database Host / Port**. If you already have your database server installed and set up, you
-   will most likely just specify `localhost` for the Database Host and
-   `5432` for the Database Port, or just `/var/run/postgresql` for
-   Database Host.
-   2. **Submitty Database User/Role and Password**. This is *not* a Linux user, just a user/role within the database server. If you don't already have a role for the submitty database user/role, the script will create that for you with the specified name & password.
-   3. **Timezone**. Pick from the list of [PHP timezones](https://www.php.net/manual/en/timezones.php).
-   4. **Main Site URL**.
-   5. **Version Control System (VCS) URL**. This is used mostly to allow students to submit their homework through private repositories hosted on the submitty server. See [Facilitating Student Submissions via GIT](/instructor/managing_git).
-   6. **Institution Name**.
-   7. **Authentication Method**. PAM and LDAP authentication requires the sysadmin to make accounts ahead of time for students and give them a password. Database authentication lets students create their own passwords.
+   Note: During installation, if you have pre-configured JSON config files, put them in `/usr/local/submitty/config/`. Otherwise, the install will generate default configs that you can edit, and will be found in the same path.
 
 
-
-3. Run installations specific to your university.
+1. Run installations specific to your university.
    For example:  [RPI Computer Science specific installations](https://github.com/Submitty/Submitty/blob/master/.setup/distro_setup/ubuntu/rpi.sh)
 
    ```
    sudo bash /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/distro_setup/ubuntu/rpi.sh
    ```
 
-
-4. Edit PHP Settings
+1. Update Config values
+```json
+{
+  "submitty_install_dir": "/usr/local/submitty", // Installation dir (created in the steps above)
+  "submitty_repository": "/usr/local/submitty/GIT_CHECKOUT/Submitty", // Where Submitty is cloned
+  "submitty_data_dir": "/var/local/submitty", // Directory where Submitty courses are stored
+  "autograding_log_path": "/var/local/submitty/logs/autograding",
+  "sys_admin_email": "sysadmin@example.com", // Sysadmin email
+  "sys_admin_url": "https://example.com",
+  "site_log_path": "/var/local/submitty/logs",
+  "submission_url": "http://localhost:1511", // URL where students will submit homework
+  "vcs_url": "", // If using VCS, the URL where students students push to
+  "cgi_url": "http://localhost:1511/cgi-bin", // Should be the <submission_url>/cgi-bin
+  "websocket_port": 8443, // Only change if required
+  "institution_name": "", // Name of your institution (e.x. Rensselaer Polytechnic Institute)
+  "institution_homepage": "", // The homepage of your institution (e.x. rpi.edu)
+  "timezone": "America/New_York", // Your time zone TZ identifier
+  "default_locale": "en_US",
+  "duck_special_effects": false, // Allow special effects
+  "course_material_file_upload_limit_mb": "100",
+  // Allow users to create their own accounts (Only works with DatabaseAuthentication), see documentation for how to use
+  "user_create_account": false, 
+  "user_id_requirements": {
+    "any_user_id": 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
+    },
+    "accepted_emails": [
+      "gmail.com"
+    ]
+  },
+  "worker": false // Is Submitty being run as a worker
+}
+```
+For switching authentication methods, edit
+`<submitty_install_dir>/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.
+
+
+1. Edit PHP Settings
 
    We recommend for security that you modify your PHP installation and disable certain PHP functions.
    To do this, edit `/etc/php/8.2/fpm/php.ini`  and find the entry for `disable_functions` and make sure the list of
@@ -84,7 +121,7 @@ You can use these [instructions](/sysadmin/installation/ansible).
 
    _Note: Depending on your version of Ubuntu, your version of php fpm will be different._
 
-5. Setup Apache
+1. Setup Apache
 
    To access Submitty's web interface, you will need to setup Apache for it.
    To help you along, we provide an annotated apache configuration for Submitty at
@@ -145,7 +182,7 @@ You can use these [instructions](/sysadmin/installation/ansible).
    At this point, you should be able to access the site by going to `your_domain`
    through a browser.
 
-6. Configure NGINX
+1. Configure NGINX
 
    Submitty uses a NGINX server to proxy the websocket server. By default
    the websocket server will run without HTTPS. If Apache is configured with
@@ -229,7 +266,7 @@ You can use these [instructions](/sysadmin/installation/ansible).
        ```
 
 
-7. We recommend that you should leave the PostgreSQL setup unless you know what
+1. We recommend that you should leave the PostgreSQL setup unless you know what
    you're doing. If you are running PostgreSQL on the same server as Submitty,
    we recommend using the UNIX socket, and to disable TCP if unused. By default,
    the socket is found at `/var/run/postgresql`, and disabling TCP is done through
@@ -239,19 +276,19 @@ You can use these [instructions](/sysadmin/installation/ansible).
    as it prevents anyone from attempting to get into the DB from the outside
    world. To disable TCP, you would comment out all the lines that start with `host`
    and `hostssl` in the `pg_hba.conf` file. Setting the socket to be used for
-   Submitty is done by running `.setup/CONFIGURE_SUBMITTY.py` and setting the
+   Submitty is done by editing `<submitty install dir>/config/database.json` and setting the
    database host to the socket (e.g. `/var/run/postgresql`).
 
    NOTES:
    - If you intend to run the [Student Registration Feed](/sysadmin/configuration/registration_feed), do not
      disable TCP.
 
-8. Test apache config with:  `apache2ctl -t`
+1. Test apache config with:  `apache2ctl -t`
 
    If everything looks ok, restart apache with:  `service apache2 restart'
 
 
-9. We suggest reviewing [Additional System Customizations](/sysadmin/installation/system_customization)
+1. We suggest reviewing [Additional System Customizations](/sysadmin/installation/system_customization)
     that might be appropriate for your installation.
 
 

_docs/sysadmin/installation/update_submitty.md

@@ -110,16 +110,7 @@ Please also see [Update GNU/Linux Server](update_server) and [Installation Versi
     will automatically call...
 
 
-5.  ```
-    sudo python3 /usr/local/submitty/GIT_CHECKOUT/Submitty/.setup/CONFIGURE_SUBMITTY.py
-    ```
-
-    This script will ask you to interactively confirm some system
-    configuration settings.  Pressing `enter/return` at each prompt
-    will keep your current configurations.
-
-
-6.  Now your system state has been updated to early June 2018.
+5.  Now your system state has been updated to early June 2018.
 
     You're ready to continue with steps 2 & 3 in the previous section
     to automatically apply _migrations_ for Submitty changes from

_docs/sysadmin/installation/worker_installation.md

@@ -48,10 +48,6 @@ _Note: These instructions should be run under root/sudo._
    bash ./.setup/install_system.sh --worker
    ```
 
-   You will be asked to provide the name of your submitty user by the
-   [CONFIGURE_SUBMITTY.py script](https://github.com/Submitty/Submitty/blob/master/.setup/CONFIGURE_SUBMITTY.py).
-
-
 6. Add the submitty user to the ```submitty_daemon```, ```submitty_daemonphp```, and ```docker```
    groups.  And add the ```submitty_daemon``` user to the ```docker``` group.