Skip to content

Commit 937d09f

Browse files
authored
[Documentation:Developer] Vagrant Port Override Env Vars (Submitty#506)
* port override env vars * reduce duplicate documentation --------- Co-authored-by: Barb Cutler <Barb Cutler>
1 parent 29ab6fe commit 937d09f

File tree

3 files changed

+55
-8
lines changed

3 files changed

+55
-8
lines changed

_docs/developer/development_instructions/troubleshooting.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,36 @@ title: Troubleshooting
33
category: Developer > Development Instructions
44
---
55

6+
7+
---
8+
9+
10+
## Forwarded Port Already in Use
11+
12+
If you see an error similar to:
13+
14+
```
15+
Vagrant cannot forward the specified ports on this VM, since they
16+
would collide with some other application that is already listening
17+
on these ports. The forwarded port to #### is already in use
18+
on the host machine.
19+
```
20+
21+
This means that one or more of the ports requested by vagrant is already in
22+
use by another application running on your computer. You can choose to use
23+
an alternate port through an environment variable. The current variables are
24+
`VM_PORT_SITE`, `VM_PORT_WS`, `VM_PORT_DB`, `VM_PORT_SAML`, and `VM_PORT_SSH`.
25+
26+
You can edit the Vagrantfile directly or create a `.env` file in the
27+
root of your project with the text (for example) `VM_PORT_SITE=1500`
28+
so that you don't have to add it to every `vagrant up` command.
29+
30+
31+
---
32+
33+
34+
## Host-Only / Static Networking
35+
636
If you are having trouble being able to view the Submitty webpage after a ```vagrant up``` you might need to
737
modify the interfaces in your VM. To fix this:
838

_docs/developer/getting_started/vm_install_using_vagrant.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ Below are quick steps to get everything installed and running.
190190
few hours depending on your Internet connection speed. When this
191191
command finishes, your VM is ready to use.
192192
193+
193194
7. When the `vagrant up` command completes successfully, you will be
194195
able to access the Submitty website (instructions follow in the
195196
next section).
@@ -226,7 +227,8 @@ Below are quick steps to get everything installed and running.
226227
```
227228
SET NO_SUBMISSIONS
228229
```
229-
When the install has completed, you should see the message:
230+
231+
8. When the install has completed, you should see the message:
230232
```
231233
#####################################################################
232234

@@ -246,11 +248,18 @@ Below are quick steps to get everything installed and running.
246248
'%NNNNNNNNNNNNNNNNNN
247249
#####################################################################
248250
```
249-
*NOTE: There are times when the install will pause for a brief period with the message `Done`. This does not mean the install has ended, and the install should continue after a bit of time.*
250251
251-
If you do not see this message due to an error or the installation has frozen,
252-
check out [Installation Troubleshooting](#installation-troubleshooting)
252+
*NOTE: There are times when the install will pause for a brief
253+
period with the message `Done`. This does not mean the install has
254+
ended, and the install should continue after a bit of time.*
255+
256+
257+
If you do not see this message due to an error or the installation
258+
has frozen, check out:
259+
260+
* [Installation Troubleshooting](#installation-troubleshooting)
253261
262+
* [Development Instructions Troubleshooting](/developer/development_instructions/troubleshooting)
254263
255264
---
256265

_docs/developer/getting_started/vm_install_using_vagrant_apple_silicon.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ the installation process.
141141
$ NO_SUBMISSIONS=1 vagrant up
142142
```
143143

144-
When the install has completed, you should see the message:
144+
6. When the install has completed, you should see the message:
145145
```
146146
#####################################################################
147147
@@ -161,10 +161,18 @@ the installation process.
161161
'%NNNNNNNNNNNNNNNNNN
162162
#####################################################################
163163
```
164-
*NOTE: There are times when the install will pause for a brief period with the message `Done`. This does not mean the install has ended, and the install should continue after a bit of time.*
164+
165+
*NOTE: There are times when the install will pause for a brief
166+
period with the message `Done`. This does not mean the install has
167+
ended, and the install should continue after a bit of time.*
168+
169+
170+
If you do not see this message due to an error or the installation
171+
has frozen, check out:
172+
173+
* [Installation Troubleshooting](#installation-troubleshooting)
165174

166-
If you do not see this message due to an error or the installation has frozen,
167-
check out [Installation Troubleshooting](vm_install_using_vagrant#installation-troubleshooting)
175+
* [Development Instructions Troubleshooting](/developer/development_instructions/troubleshooting)
168176

169177
---
170178

0 commit comments

Comments
 (0)