Skip to content

Commit d96f58b

Browse files
Barb CutlerBarb Cutler
Barb Cutler
authored and
Barb Cutler
committed
Merge branch 'merge-m-series' of github.com:Submitty/submitty.github.io into merge-m-series
2 parents fd33293 + f982029 commit d96f58b

File tree

1 file changed

+73
-62
lines changed

1 file changed

+73
-62
lines changed

Diff for: _docs/developer/getting_started/vm_install_using_vagrant.md

+73-62
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Unix/Linux). The installation process will create a new Virtual
1414
Machine (VM) on your computer and the VM will use the Ubuntu GNU/Linux
1515
operating system.
1616

17-
***NOTE:** We only officially support and test development using VirtualBox for AMD
18-
and Intel machines and QEMU for M-Series ARM MacOS machines.*
17+
***NOTE:** We only officially support and test development using VirtualBox for AMD and Intel machines and QEMU for M-Series ARM MacOS machines.*
1918

2019
---
2120

@@ -57,7 +56,7 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.*
5756
check the box next to your name in the list below.
5857

5958
6. The complete installation process could take an hour or more and
60-
will quite possiby fail if paused or interrupted. Make
59+
will quite possibly fail if paused or interrupted. Make
6160
sure your internet connection is strong and consistent. You'll
6261
probably want to plug in your laptop power cord. Check your
6362
computer settings and make sure the machine does not hibernate or
@@ -240,68 +239,70 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.*
240239
241240
* **Build pre-packaged VM**
242241
243-
*NOTE: The pre-packaged Submitty VM is not (yet)
244-
available for qemu / M-Series ARM Mac machines.*
245-
246-
If you are using VirtualBox as your provider, you will by default
247-
use a pre-packaged Submitty VM. This will have all of Submitty
248-
already setup. This is a recently built machine,
249-
but it may be slightly older than the current
250-
[main branch on GitHub](https://github.com/Submitty/Submitty).
251-
252-
253-
To create the virtual machine from the pre-packaged image, run:
254-
```
255-
vagrant up --provider=virtualbox
256-
```
257-
258-
If you wish to use a specific version of the pre-packaged Submitty VM, on Linux type:
259-
```
260-
PREBUILT_VERSION={version} vagrant up --provider=virtualbox
261-
```
262-
263-
or on Windows, type:
264-
```
265-
SET PREBUILT_VERSION={version}
266-
vagrant up --provider=virtualbox
267-
```
268-
269-
*The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`*
270-
271-
*This process will take 10 minutes to maybe half an hour
272-
depending on your internet connection speed.*
273-
274-
275-
***Note:** The vagrant up command creates and provisions the virtual machine on the first run.
276-
The `--provider` flag is important if you have more than one virtual box provider
277-
installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt).
278-
For subsequent runs, you do not need to append the `--provider` flag as the VM is
279-
already created.*
280-
281-
282-
* **Build (from scratch) using QEMU on an M-Series Arm MacOKS**
283-
284-
If you have an M-series ARM MacOS, run:
285-
```
286-
vagrant up --provider=qemu
287-
```
288-
289-
*As noted above, the `--provider` flag is only necessary on the first run when the VM is created.*
242+
*NOTE: The pre-packaged Submitty VM is not (yet)
243+
available for qemu / M-Series ARM Mac machines.*
244+
245+
If you are using VirtualBox as your provider, you will by default
246+
use a pre-packaged Submitty VM. This will have all of Submitty
247+
already setup. This is a recently built machine,
248+
but it may be slightly older than the current
249+
[main branch on GitHub](https://github.com/Submitty/Submitty).
250+
251+
252+
To create the virtual machine from the pre-packaged image, run:
253+
```
254+
vagrant up --provider=virtualbox
255+
```
256+
257+
If you wish to use a specific version of the pre-packaged Submitty VM, on Linux/MacOS type:
258+
```
259+
PREBUILT_VERSION={version} vagrant up --provider=virtualbox
260+
```
261+
262+
or on Windows, type:
263+
```
264+
SET PREBUILT_VERSION={version}
265+
vagrant up --provider=virtualbox
266+
```
267+
268+
*The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`*
269+
270+
*This process will take 10 minutes to maybe half an hour
271+
depending on your internet connection speed.*
272+
273+
274+
***Note:** The vagrant up command creates and provisions the virtual machine on the first run.
275+
The `--provider` flag is important if you have more than one provider
276+
installed on your machine (e.g., VirtualBox, VMWare, QEMU, libvirt).
277+
For subsequent runs, you do not need to append the `--provider` flag as the VM is
278+
already created.*
279+
280+
281+
* **Build (from scratch) using QEMU on an M-Series Arm MacOS**
282+
283+
If you have an M-series ARM Mac, run:
284+
```
285+
vagrant up --provider=qemu
286+
```
287+
288+
*As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.*
290289
291290
292291
* **Build from scratch**
293292
294-
If you wish to run `vagrant up` from scratch, on Linux or IntelMac type:
293+
If you wish to run `vagrant up` from scratch, on Linux or Intel-based Mac type:
295294
```
296-
FROM_SCRATCH=1 vagrant up
295+
FROM_SCRATCH=1 vagrant up --virtualbox
297296
```
298297
299-
Or on Windows, type:
298+
Or on Windows with `cmd`, type:
300299
```
301300
SET FROM_SCRATCH=1
302-
vagrant up
301+
vagrant up --virtualbox
303302
```
304303
304+
*As noted above, you do not need to append the `--provider` flag on subsequent runs after the VM is already created.*
305+
305306
*This process will take anywhere from 30 minutes to a few hours
306307
depending on your internet speed.*
307308
@@ -315,50 +316,60 @@ and Intel machines and QEMU for M-Series ARM MacOS machines.*
315316
users in the sample courses.*
316317
317318
318-
* **Build without sample submissions**
319+
* **Build from scratch without sample submissions**
319320
320321
If your development work *will not require sample assignment
321322
submissions or autograding results*, you may prepend
322323
`NO_SUBMISSIONS=1` to the previous command, which will skip the
323324
creation of these sample submissions and their autograding and
324325
decrease the time to complete installation.
325326
327+
* On Linux or Intel-based Mac:
328+
```
329+
NO_SUBMISSIONS=1 FROM_SCRATCH=1 vagrant up --provider=virtualbox
330+
```
326331
327-
* On Mac or Linux:
332+
* On M-series ARM Mac:
328333
```
329-
NO_SUBMISSIONS=1 vagrant up
334+
NO_SUBMISSIONS=1 vagrant up --provider=qemu
330335
```
331336
332-
* Or on Windows using `cmd`:
337+
* On Windows using `cmd`:
333338
```
334339
SET NO_SUBMISSIONS=1
335-
vagrant up
340+
SET FROM_SCRATCH=1
341+
vagrant up --provider=virtualbox
336342
```
337343
338-
Or on Windows using PowerShell, you will have to set the environment variable differently:
344+
On Windows using PowerShell, you will have to set the environment variables differently:
339345
```pwsh
340346
$Env:NO_SUBMISSIONS=1
347+
$Env:FROM_SCRATCH=1
341348
vagrant up
342349
```
343350
344-
If you want to unset the variable later in `cmd`, you can do:
351+
If you want to unset the variables later in `cmd`, you can do:
345352
```
346353
SET NO_SUBMISSIONS=
354+
SET FROM_SCRATCH=
347355
```
348356
349357
Or in PowerShell:
350358
```pwsh
351359
Remove-Item Env:\NO_SUBMISSIONS
360+
Remove-Item Env:\FROM_SCRATCH
352361
```
353362
354-
Similarly, you can check that the variable is set by doing:
363+
Similarly, you can check that the variables are set in `cmd` with:
355364
```
356365
SET NO_SUBMISSIONS
366+
SET FROM_SCRATCH
357367
```
358368
359369
Or in PowerShell:
360370
```pwsh
361371
$Env:NO_SUBMISSIONS
372+
$Env:FROM_SCRATCH
362373
```
363374
364375

0 commit comments

Comments
 (0)