From cbf975fb01f17dab9af7ede33e5be5e782313de5 Mon Sep 17 00:00:00 2001 From: Michael Becker Date: Thu, 18 Apr 2024 13:44:16 -0400 Subject: [PATCH] update README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff9f8d1..8da09ef 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The SUV Provisioner uses `hexdump` to generate random ID numbers for newly-provi The SUV Provisioner uses `vagrant` for virtual machine provisioning, which itself uses `virtualbox`. - +## Configuration The IP address ranges generated by the provisioner are outside the typically allowed range for VirtualBox host-only networks. To fix this, either change `SUV_IP_PREFIX` in `./provision` or create/open file `/etc/vbox/networks.conf` and add the following lines: @@ -19,9 +19,12 @@ The IP address ranges generated by the provisioner are outside the typically all * 2001::/64 ``` - ## Installation 1. Clone the repository with `git clone` 2. Initialize and update submodules with `git submodule init` and `git submodule update` 3. Provision a new Mocha Single User Version (SUV) with `./suv new` + +## Usage + +The provisioning process will create a new VirtualBox virtual machine with the appropriate configuration, download and install updates and packages for the virtual machine's operating system, and copy files related to the Mocha advanced database infrastructure. This process may take a long time. When the build is finished, the newly-provisioned virtual machine will be running and listening for requests. Point your favorite browser to the IP address or host name of the virtual machine (displayed at the end of the provisioning process) and log in with the displayed credentials. \ No newline at end of file