Skip to content

Commit

Permalink
[Documentation:Developer] Add new ENV variables (#616)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
IDzyre authored Jul 9, 2024
1 parent b61a08e commit ef2f5f0
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions _docs/developer/getting_started/vm_install_using_vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,28 +244,39 @@ If you using an Intel-based Mac, you will follow the instructions below._
* **Build pre-packaged VM**
If you are using VirtualBox as your provider, you will by default
use a pre-packaged Submitty VM. This will have all of Submitty
already setup. Vagrant will build your VM for you.
If you are using VirtualBox as your provider, you will by default
use a pre-packaged Submitty VM. This will have all of Submitty
already setup. Vagrant will build your VM for you.
```
vagrant up
```
```
vagrant up
```
If you wish to use a specific version of the pre-packaged Submitty VM, on Linux or Mac type:
```
PREBUILT_VERSION={version} vagrant up
```
or on Windows, type:
```
SET PREBUILT_VERSION={version}
vagrant up
```
*The version must be only the numbers, not including the `v` in front, for example `24.05.00.2405260215` not `v24.05.00.2405260215`*
*This process will take 10 minutes to maybe half an hour
depending on your internet connection speed.*
*This process will take 10 minutes to maybe half an hour
depending on your internet connection speed.*
* **Build from scratch**
If you wish to run `vagrant up` from scratch, on Linux or Mac type:
```
BASE_BOX=1 vagrant up
FROM_SCRATCH=1 vagrant up
```
Or on Windows, type:
```
SET BASE_BOX=1
SET FROM_SCRATCH=1
vagrant up
```
Expand Down

0 comments on commit ef2f5f0

Please sign in to comment.