Skip to content

Commit 8a2640a

Browse files
committed
updating documentation for PR
1 parent e32a7de commit 8a2640a

File tree

2 files changed

+33
-18
lines changed

2 files changed

+33
-18
lines changed

_docs/sysadmin/installation/ansible_index.md renamed to _docs/sysadmin/installation/ansible.md

+29-17
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
title: Installing with Ansible
33
category: System Administrator > Installation
44
redirect_from:
5-
- /developer/installation
65
---
76

8-
These are the ansible install instructions that will help guide you to installing Submitty onto a server.
7+
These are the instructions for install Submitty using Ansible.
98

109
Getting Started:
1110

@@ -19,34 +18,41 @@ Getting Started:
1918

2019
2. Install Ansible:
2120

22-
Installing ansible on your local environment is required. Below is a link for more help.
21+
Installing Ansible on your local environment is required. Below is a link for more help.
2322

2423
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
2524

2625

2726
3. Edit Inventory and Add Server IP:
2827

29-
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.
28+
An example has been given to you in the inventory file. Update localhost with your server ip address.
29+
This will allow access to your web interface.
3030

31-
4. Edit playbook variables with your server properties(ansible/playbooks/submitty_install.yml):
31+
4. Edit playbook variables with your server properties(`ansible/playbooks/submitty_install.yml`):
3232

33-
Note: Configure your playbook with your Submitty settings. See `ansible/roles/app_submitty/defaults/main.yml` for default installation parameters.
33+
Note: Configure your playbook with your Submitty settings. See
34+
`ansible/roles/app_submitty/defaults/main.yml` for default installation parameters.
3435

35-
**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.
36+
**Important**: Any variables defined in the playbook will take precedence over the default values.
37+
This allows for fine-tuning and customization of your Submitty installation.
3638

37-
5. SSL COnfiguration
39+
5. SSL Configuration
3840

3941
Note: If you use SSL, follow steps to configure. If not, skip to step 6.
4042

41-
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.
43+
Secure Sockets Layer (SSL) is a protocol for establishing authenticated and encrypted links between
44+
networked computers. It's necessary for secure data transmission, such as user login credentials.
4245

43-
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.
46+
To configure SSL for your Submitty installation, you'll need to obtain an SSL certificate. This can
47+
be from a Certificate Authority (CA) or a self-signed certificate if it's for development purposes.
4448

45-
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).
49+
Once you have your certificate and key, place them in the appropriate directory (usually
50+
`/etc/ssl/certs/` for the certificate and `/etc/ssl/private/` for the key).
4651

47-
Then, update your server's SSL configuration file with the paths to your certificate and key. The relevant lines might look something like this:
52+
Then, update your server's SSL configuration file with the paths to your certificate and key.
53+
The relevant lines might look something like this:
4854

49-
```bash
55+
```
5056
SSLCertificateFile /etc/ssl/certs/mycert.pem
5157
SSLCertificateKeyFile /etc/ssl/private/mykey.pem
5258
```
@@ -55,22 +61,28 @@ Getting Started:
5561

5662
6. Run Ansible Script
5763

58-
To initiate the installation process, first navigate to the 'ansible' directory, then the install directory. You can execute the following command:
64+
To initiate the installation process, first navigate to the 'ansible' directory.
65+
Execute the following command:
66+
5967
```
6068
cd ansible
6169
```
6270

63-
Once you are in the `ansible` directory, you can proceed with the installation by running the Ansible playbook:
71+
Once you are in the `ansible` directory, you can proceed with the installation by running the
72+
Ansible playbook:
6473

6574
```
6675
ansible-playbook -i inventory/submitty playbooks/submitty_install.yml
6776
```
6877

69-
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`.
78+
This command initiates the Ansible playbook, which orchestrates the comprehensive installation
79+
process for Submitty. For a detailed understanding of the installation steps, refer to
80+
`ansible/roles/app_submitty/tasks/main.yml`.
7081

7182
7. Review Installation Log on VM
7283

73-
Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the install process.
84+
Navigate to `/usr/local/submitty/install.log` on your machine(or VM) to see the output of the
85+
install process.
7486

7587
8. Navigate to Web Interface
7688

_docs/sysadmin/installation/index.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ will be able to read/execute it.
2323

2424
_Note: These instructions should be run under root/sudo._
2525

26-
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.
26+
We have two methods for installing Submitty. The first method is running the bootstrap
27+
script which follows the set of instructions listed below. The second installation method uses Ansible.
28+
You can use these [instructions](/sysadmin/installation/ansible).
29+
2730

2831
1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os)
2932

0 commit comments

Comments
 (0)