Skip to content

Commit c5e6af9

Browse files
authored
[Feature:Developer] Allow customization of VM resources (#695)
This adds the documentation for the new environment variables added in Submitty/Submitty#11922
1 parent f35395d commit c5e6af9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

_docs/developer/getting_started/vm_install_using_vagrant.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -611,3 +611,15 @@ please follow the step below:
611611
The script should automatically handle the upgrading and issuing a self-signed
612612
certificate. If your browser complains about the security, please head to
613613
[WebSocket](/developer/developing_the_php_site/websocket).
614+
615+
---
616+
617+
## Increasing VM Resources
618+
If you find that the VM is running slowly, you can increase the resources allocated to it. By default the VM is allocated 2GB of RAM and 2 CPUs. You can increase these values by setting the `VM_MEMORY` and `VM_CPUS` environment variables before running `vagrant up`. For example, to allocate 4GB of RAM and 4 CPUs, you can run:
619+
620+
```sh
621+
export VM_MEMORY=4096
622+
export VM_CPUS=4
623+
vagrant up
624+
```
625+
If your system has 8GB of RAM it is recommended to set `VM_MEMORY` to 4096 (4GB) and `VM_CPUS` to 2 or 4. If your system has more RAM, you can increase these values further, but be careful not to allocate too much RAM as it may cause your host system to become unresponsive.

0 commit comments

Comments
 (0)