From 87ac41d08978fa8a57218ec11800f9a191fc781c Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:09:09 -0800 Subject: [PATCH 01/12] [Documentation:developer] Adding Ansible Script Process --- _docs/sysadmin/installation/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index d6006d40..cf2d8ede 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,6 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ _here_ }}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From e6590994f25902d52f531aead4f072a76fe7b9b9 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:36:37 -0800 Subject: [PATCH 02/12] updating --- _docs/sysadmin/installation/ansible_index.md | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 _docs/sysadmin/installation/ansible_index.md diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md new file mode 100644 index 00000000..7ef872f6 --- /dev/null +++ b/_docs/sysadmin/installation/ansible_index.md @@ -0,0 +1,25 @@ +--- +title: Overview +category: System Administrator > Installation +redirect_from: + - /developer/installation +--- + +These instructions will help guide you to installing Submitty onto a +server (whether on a dedicated machine or a VM). + +**Note**: We assume that you're installing Submitty on a dedicated machine. + +1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) + + Note: If you are duplicating an existing Submitty installation onto a new server, you should + 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. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) + +Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This + + + + From 20e116815dd153048b605fc0b2570c5efd55d6c3 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 7 Mar 2024 15:53:04 -0800 Subject: [PATCH 03/12] updating --- _docs/sysadmin/installation/ansible_index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 7ef872f6..6ef9b27d 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -18,7 +18,9 @@ server (whether on a dedicated machine or a VM). 2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) -Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This + Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + +3. [] From 25aa4fcb0de8f4545e1804c70e1cb2e1ada31d72 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Mon, 11 Mar 2024 13:45:36 -0700 Subject: [PATCH 04/12] [Documentation:Developer] adding ansible script option --- _docs/sysadmin/installation/ansible_index.md | 11 +++++++++-- _docs/sysadmin/installation/index.md | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 6ef9b27d..fdcf61f7 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -18,10 +18,17 @@ server (whether on a dedicated machine or a VM). 2. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) - Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + Note: Your edits should match your dedicated machine(or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. -3. [] +3. [Run ansible script] + In the terminal, run the command: + Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml +This ansible command will run the entire Submitty install process step by step. See (ansible/roles/app_submitty/tasks/main.yml) for more information on the Install process. + +4. [Check Install Log] + Navigate to (/usr/local/submitty/install.log) on your machine(or VM) to see the output of the install process. + diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index cf2d8ede..48c1d4fd 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ _here_ }}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ https://github.com/submitty.github.io/blob/main/_docs/sysadmin/installation/ansible_index.md}}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From 2bcd73577b52bd3b90dea20d47ca02f75c81963d Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Mon, 11 Mar 2024 16:42:14 -0700 Subject: [PATCH 05/12] [Documentation:Developer] Adding instructions --- _docs/sysadmin/installation/ansible_index.md | 43 +++++++++++++++----- _docs/sysadmin/installation/index.md | 2 +- 2 files changed, 34 insertions(+), 11 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index fdcf61f7..0cde4fcb 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -1,12 +1,18 @@ --- -title: Overview +title: Installing with Ansible category: System Administrator > Installation redirect_from: - /developer/installation --- -These instructions will help guide you to installing Submitty onto a -server (whether on a dedicated machine or a VM). +These are the ansible install instructions that will help guide you to installing Submitty onto a +server. + +Things you need before starting: +Need a machine with ansible - find link how to install ansible on any machine + + + **Note**: We assume that you're installing Submitty on a dedicated machine. @@ -16,19 +22,36 @@ server (whether on a dedicated machine or a VM). 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. [Edit default playbook to match your server](ansible/playbooks/submitty_install.yml) +2. Edit inventory and add server IP + + Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + +3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml) - Note: Your edits should match your dedicated machine(or VM) necessary requirements to properly install Submitty onto your machine. This will ensure the install script can run without failure. See ansible/roles/app_submitty/defaults/main.yml for example. + Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -3. [Run ansible script] + + +ssl + +3. Run ansible script In the terminal, run the command: - Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml -This ansible command will run the entire Submitty install process step by step. See (ansible/roles/app_submitty/tasks/main.yml) for more information on the Install process. + ``` + Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml + ``` + + This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. + +4. Check Install Log -4. [Check Install Log] - Navigate to (/usr/local/submitty/install.log) on your machine(or VM) to see the output of the install process. + Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. +access +THings you need +Clean ubuntu install +a machine that runs ansible (probably not the ubuntu vm) +need a machine that runs ansible and can connect diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 48c1d4fd..204e9bdf 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script, with the instructions being listed {{ https://github.com/submitty.github.io/blob/main/_docs/sysadmin/installation/ansible_index.md}}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions {{here}}. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From bf96c71f67f3398513c3def83abb1bbdad46843b Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 14 Mar 2024 14:16:57 -0700 Subject: [PATCH 06/12] working --- _docs/sysadmin/installation/ansible_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 0cde4fcb..60673d10 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -22,11 +22,11 @@ Need a machine with ansible - find link how to install ansible on any machine 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. Edit inventory and add server IP +2. Edit inventory and add server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. -3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml) +3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. From 8499f9d45883cff5d3e90a2f9b8ebd5d99338235 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 14 Mar 2024 14:17:23 -0700 Subject: [PATCH 07/12] working --- _docs/sysadmin/installation/ansible_index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 60673d10..9b72ab98 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -22,6 +22,11 @@ Need a machine with ansible - find link how to install ansible on any machine 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. Install Ansible: + + + + 2. Edit inventory and add server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. From bbe04d1e560e21e49bf37b12cab5c68563474118 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 15 Mar 2024 15:54:03 -0700 Subject: [PATCH 08/12] fixing documentation --- _docs/sysadmin/installation/ansible_index.md | 31 ++++++++------------ 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 9b72ab98..ccc0e303 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -5,14 +5,9 @@ redirect_from: - /developer/installation --- -These are the ansible install instructions that will help guide you to installing Submitty onto a -server. - -Things you need before starting: -Need a machine with ansible - find link how to install ansible on any machine - - +These are the ansible install instructions that will help guide you to installing Submitty onto a server. +Getting Started: **Note**: We assume that you're installing Submitty on a dedicated machine. @@ -24,22 +19,24 @@ Need a machine with ansible - find link how to install ansible on any machine 2. Install Ansible: - + Installing ansible on your local environment is required. Below is a link for more help. + + https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html -2. Edit inventory and add server IP: +3. Edit Inventory and Add Server IP: Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. -3. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): +4. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -ssl +**ssl** -3. Run ansible script +6. Run Ansible Script In the terminal, run the command: @@ -49,14 +46,10 @@ ssl This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. -4. Check Install Log +7. Check Install Log Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. -access - +8. Navigate to Web Server -THings you need -Clean ubuntu install -a machine that runs ansible (probably not the ubuntu vm) -need a machine that runs ansible and can connect + Navigate to your servers IP in a web browser. From 852bd2a3675e8b8d0c2466ab59f93d4f4ff10420 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Fri, 5 Apr 2024 13:39:16 -0700 Subject: [PATCH 09/12] [Documentation:Developer] Add Ansible Install Script Documentation --- _docs/sysadmin/installation/ansible_index.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index ccc0e303..8fdb1e57 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -26,15 +26,28 @@ Getting Started: 3. Edit Inventory and Add Server IP: - Replace submitty_ip with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + Replace 'submitty_ip' with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. 4. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. +5. Configure SSL + Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. -**ssl** + To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. + + Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). + + Then, update the `ansible/roles/app_submitty/defaults/main.yml` file with the paths to your certificate and key. The relevant lines might look something like this: + + ```yaml + ssl_certificate: /etc/ssl/certs/mycert.pem + ssl_certificate_key: /etc/ssl/private/mykey.pem + ``` + + Save your changes and proceed to run the Ansible script. 6. Run Ansible Script @@ -44,7 +57,7 @@ Getting Started: Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` - This ansible command will run the entire Submitty install process step by step. See `ansible/roles/app_submitty/tasks/main.yml` for more information on the Install process. +This command initiates the Ansible playbook, which orchestrates the comprehensive installation process for Submitty. For a detailed understanding of the installation steps, refer to `ansible/roles/app_submitty/tasks/main.yml`. 7. Check Install Log From 3cfd6e5e703324ec628bcc0d5cb367036e40240b Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 10:43:05 -0700 Subject: [PATCH 10/12] [Documentation] Ansible Install Script --- _docs/sysadmin/installation/ansible_index.md | 35 ++++++++++++-------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible_index.md index 8fdb1e57..3f7bcaff 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible_index.md @@ -26,13 +26,17 @@ Getting Started: 3. Edit Inventory and Add Server IP: - Replace 'submitty_ip' with your machine's IP address. This will give you access to the site on the server once the install process is completed successfully. + An example has been given to you in the inventory file. Update localhost with your server ip address. This will allow access to your web interface. -4. Edit default playbook to match your server(ansible/playbooks/submitty_install.yml): +4. Edit playbook variables with your server properties(ansible/playbooks/submitty_install.yml): - Note: Your edits should match your dedicated machine (or VM) necessary requirements to properly install Submitty onto your machine. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. + Note: Configure your playbook with your Submitty settings. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. -5. Configure SSL + **Important**: Any variables defined in the playbook will take precedence over the default values. This allows for fine-tuning and customization of your Submitty installation. + +5. SSL COnfiguration + + Note: If you use SSL, follow steps to configure. If not, skip to step 6. Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. @@ -40,29 +44,34 @@ Getting Started: Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). - Then, update the `ansible/roles/app_submitty/defaults/main.yml` file with the paths to your certificate and key. The relevant lines might look something like this: + Then, update your server's SSL configuration file with the paths to your certificate and key. The relevant lines might look something like this: - ```yaml - ssl_certificate: /etc/ssl/certs/mycert.pem - ssl_certificate_key: /etc/ssl/private/mykey.pem + ```bash + SSLCertificateFile /etc/ssl/certs/mycert.pem + SSLCertificateKeyFile /etc/ssl/private/mykey.pem ``` Save your changes and proceed to run the Ansible script. 6. Run Ansible Script - In the terminal, run the command: + To initiate the installation process, first navigate to the 'ansible' directory, then the install directory. You can execute the following command: + ``` + cd ansible + ``` + + Once you are in the `ansible` directory, you can proceed with the installation by running the Ansible playbook: ``` - Ansible-playbook -i inventory/submitty playbooks/submitty_install.yml + ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` This command initiates the Ansible playbook, which orchestrates the comprehensive installation process for Submitty. For a detailed understanding of the installation steps, refer to `ansible/roles/app_submitty/tasks/main.yml`. -7. Check Install Log +7. Review Installation Log on VM Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. -8. Navigate to Web Server +8. Navigate to Web Interface - Navigate to your servers IP in a web browser. + Navigate to your domain name in a web browser. From e32a7de1b7db2b1c44f12685e1183dc785a8c762 Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 10:46:50 -0700 Subject: [PATCH 11/12] adding ansible install instructions to index.md --- _docs/sysadmin/installation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 204e9bdf..49bfd075 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,7 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions {{here}}. +We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions in ansible_index.md. 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os) From 8a2640afff57908fffac1535b362c3a8c17d813c Mon Sep 17 00:00:00 2001 From: Ethan Ford Date: Thu, 18 Apr 2024 11:41:35 -0700 Subject: [PATCH 12/12] updating documentation for PR --- .../{ansible_index.md => ansible.md} | 46 ++++++++++++------- _docs/sysadmin/installation/index.md | 5 +- 2 files changed, 33 insertions(+), 18 deletions(-) rename _docs/sysadmin/installation/{ansible_index.md => ansible.md} (56%) diff --git a/_docs/sysadmin/installation/ansible_index.md b/_docs/sysadmin/installation/ansible.md similarity index 56% rename from _docs/sysadmin/installation/ansible_index.md rename to _docs/sysadmin/installation/ansible.md index 3f7bcaff..10ef6baa 100644 --- a/_docs/sysadmin/installation/ansible_index.md +++ b/_docs/sysadmin/installation/ansible.md @@ -2,10 +2,9 @@ title: Installing with Ansible category: System Administrator > Installation redirect_from: - - /developer/installation --- -These are the ansible install instructions that will help guide you to installing Submitty onto a server. +These are the instructions for install Submitty using Ansible. Getting Started: @@ -19,34 +18,41 @@ Getting Started: 2. Install Ansible: - Installing ansible on your local environment is required. Below is a link for more help. + Installing Ansible on your local environment is required. Below is a link for more help. https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html 3. Edit Inventory and Add Server IP: - An example has been given to you in the inventory file. Update localhost with your server ip address. This will allow access to your web interface. + An example has been given to you in the inventory file. Update localhost with your server ip address. + This will allow access to your web interface. -4. Edit playbook variables with your server properties(ansible/playbooks/submitty_install.yml): +4. Edit playbook variables with your server properties(`ansible/playbooks/submitty_install.yml`): - Note: Configure your playbook with your Submitty settings. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. + Note: Configure your playbook with your Submitty settings. See + `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters. - **Important**: Any variables defined in the playbook will take precedence over the default values. This allows for fine-tuning and customization of your Submitty installation. + **Important**: Any variables defined in the playbook will take precedence over the default values. + This allows for fine-tuning and customization of your Submitty installation. -5. SSL COnfiguration +5. SSL Configuration Note: If you use SSL, follow steps to configure. If not, skip to step 6. - Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between networked computers. It's necessary for secure data transmission, such as user login credentials. + Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between + networked computers. It's necessary for secure data transmission, such as user login credentials. - To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. + To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can + be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes. - Once you have your certificate and key, place them in the appropriate directory (usually `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). + Once you have your certificate and key, place them in the appropriate directory (usually + `/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key). - Then, update your server's SSL configuration file with the paths to your certificate and key. The relevant lines might look something like this: + Then, update your server's SSL configuration file with the paths to your certificate and key. + The relevant lines might look something like this: - ```bash + ``` SSLCertificateFile /etc/ssl/certs/mycert.pem SSLCertificateKeyFile /etc/ssl/private/mykey.pem ``` @@ -55,22 +61,28 @@ Getting Started: 6. Run Ansible Script - To initiate the installation process, first navigate to the 'ansible' directory, then the install directory. You can execute the following command: + To initiate the installation process, first navigate to the 'ansible' directory. + Execute the following command: + ``` cd ansible ``` - Once you are in the `ansible` directory, you can proceed with the installation by running the Ansible playbook: + Once you are in the `ansible` directory, you can proceed with the installation by running the + Ansible playbook: ``` ansible-playbook -i inventory/submitty playbooks/submitty_install.yml ``` -This command initiates the Ansible playbook, which orchestrates the comprehensive installation process for Submitty. For a detailed understanding of the installation steps, refer to `ansible/roles/app_submitty/tasks/main.yml`. + This command initiates the Ansible playbook, which orchestrates the comprehensive installation + process for Submitty. For a detailed understanding of the installation steps, refer to + `ansible/roles/app_submitty/tasks/main.yml`. 7. Review Installation Log on VM - Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process. + Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the + install process. 8. Navigate to Web Interface diff --git a/_docs/sysadmin/installation/index.md b/_docs/sysadmin/installation/index.md index 49bfd075..26203d87 100644 --- a/_docs/sysadmin/installation/index.md +++ b/_docs/sysadmin/installation/index.md @@ -23,7 +23,10 @@ will be able to read/execute it. _Note: These instructions should be run under root/sudo._ -We have two methods for installing Submitty. The first method is running the bootstrap script which follows the set of instructions listed below. The second is through running the Ansible script. We find these instructions in ansible_index.md. +We have two methods for installing Submitty. The first method is running the bootstrap +script which follows the set of instructions listed below. The second installation method uses Ansible. +You can use these [instructions](/sysadmin/installation/ansible). + 1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os)