Skip to content

Commit ef2f5f0

Browse files
authored
[Documentation:Developer] Add new ENV variables (#616)
This adds documentation for: * the change from BASE_BOX=1 to FROM_SCRATCH=1, BASE_BOX=1 will still be available to use, but will be removed eventually as the naming was confusing. * supporting PREBUILT_VERSION for specifying a prebuilt version * Tip for using NO_SUBMISSIONS=1 if Git is failing
1 parent b61a08e commit ef2f5f0

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

_docs/developer/getting_started/vm_install_using_vagrant.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -244,28 +244,39 @@ If you using an Intel-based Mac, you will follow the instructions below._
244244
245245
* **Build pre-packaged VM**
246246
247-
If you are using VirtualBox as your provider, you will by default
248-
use a pre-packaged Submitty VM. This will have all of Submitty
249-
already setup. Vagrant will build your VM for you.
247+
If you are using VirtualBox as your provider, you will by default
248+
use a pre-packaged Submitty VM. This will have all of Submitty
249+
already setup. Vagrant will build your VM for you.
250250
251-
```
252-
vagrant up
253-
```
251+
```
252+
vagrant up
253+
```
254+
255+
If you wish to use a specific version of the pre-packaged Submitty VM, on Linux or Mac type:
256+
```
257+
PREBUILT_VERSION={version} vagrant up
258+
```
259+
or on Windows, type:
260+
```
261+
SET PREBUILT_VERSION={version}
262+
vagrant up
263+
```
264+
*The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`*
254265
255-
*This process will take 10 minutes to maybe half an hour
256-
depending on your internet connection speed.*
266+
*This process will take 10 minutes to maybe half an hour
267+
depending on your internet connection speed.*
257268
258269
259270
* **Build from scratch**
260271
261272
If you wish to run `vagrant up` from scratch, on Linux or Mac type:
262273
```
263-
BASE_BOX=1 vagrant up
274+
FROM_SCRATCH=1 vagrant up
264275
```
265276
266277
Or on Windows, type:
267278
```
268-
SET BASE_BOX=1
279+
SET FROM_SCRATCH=1
269280
vagrant up
270281
```
271282

0 commit comments

Comments
 (0)