Skip to content

Commit 39f7a32

Browse files
committed
fixed hyperlink
1 parent 1eb18c6 commit 39f7a32

File tree

5 files changed

+41
-13
lines changed

5 files changed

+41
-13
lines changed

docs/Installing BitCurator/Installing BitCurator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Installation Instructions
3232

3333
This is the preferred method for running the BitCurator Environment.
3434

35-
[Install the BitCurator toolset in an **existing Ubuntu environment**](https://github.com/bitcurator/bitcurator-distro-salt)
35+
[Install the BitCurator toolset in an **existing Ubuntu environment**](https://github.com/bitcurator/bitcurator-salt)
3636

3737
If you have an existing Ubuntu compatible environment on either a direct partition or in a virtual machine, you can build the BitCurator stack in it.
3838

site/Installing BitCurator/Installation via Virtual Machine/index.html

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,24 @@
5959
<li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a>
6060
</li>
6161
<li class="toctree-l2"><a class="reference internal" href="#installation-instructions">Installation Instructions</a>
62+
<ul>
63+
<li class="toctree-l3"><a class="reference internal" href="#step-1-download-software">Step 1: Download Software</a>
64+
</li>
65+
<li class="toctree-l3"><a class="reference internal" href="#step-2-unpack-the-bitcurator-virtual-machine">Step 2: Unpack the BitCurator Virtual Machine</a>
66+
</li>
67+
<li class="toctree-l3"><a class="reference internal" href="#step-3-open-oracle-vm-virtualbox-manager">Step 3: Open Oracle VM VirtualBox Manager</a>
68+
</li>
69+
<li class="toctree-l3"><a class="reference internal" href="#step-4-add-a-virtual-machine">Step 4: Add a Virtual Machine</a>
70+
</li>
71+
<li class="toctree-l3"><a class="reference internal" href="#step-5-configure-ram-and-processors">Step 5: Configure RAM and Processors</a>
72+
</li>
73+
<li class="toctree-l3"><a class="reference internal" href="#step-6-enable-usb-device-capture">Step 6: Enable USB Device Capture</a>
74+
</li>
75+
<li class="toctree-l3"><a class="reference internal" href="#step-7-setup-shared-folders">Step 7: Setup Shared Folders</a>
76+
</li>
77+
<li class="toctree-l3"><a class="reference internal" href="#step-8-starting-the-bitcurator-environment-vm">Step 8: Starting the BitCurator Environment (VM)</a>
78+
</li>
79+
</ul>
6280
</li>
6381
<li class="toctree-l2"><a class="reference internal" href="#virtual-machine-login">Virtual Machine Login</a>
6482
</li>
@@ -149,10 +167,14 @@ <h3 id="overview">Overview</h3>
149167
<li>12 GB free hard disk space minimum. The virtual machine is approximately 9 GB. It will expand to 256 GB as needed</li>
150168
</ul>
151169
<h3 id="installation-instructions">Installation Instructions</h3>
152-
<p>Step 1: Download Software<em> BitCurator Virtual Machine or Live CD: <a href="https://github.com/BitCurator/bitcurator-distro/wiki/Releases">https://github.com/BitCurator/bitcurator-distro/wiki/Releases</a>
153-
* Current release of VirtualBox: <a href="https://www.virtualbox.org/wiki/Downloads">https://www.virtualbox.org/wiki/Downloads</a>
154-
* The VirtualBox Extension Pack </em><em>must</em><em> be installed on the host for shared folder support, USB 2.0/3.0 support, and support for some NVMe SSDs. Once you’ve installed VirtualBox, use the link below the main download on VirtualBox download site to install the Extension Pack on your host.
155-
Step 2: Unpack the BitCurator Virtual MachineThe BitCurator Virtual Machine is packaged as a tar archive and compressed with gzip. The file will look something like: </em><em>“BitCurator-X.X.X.tar.gz”</em>*</p>
170+
<h4 id="step-1-download-software">Step 1: Download Software</h4>
171+
<ul>
172+
<li>BitCurator Virtual Machine or Live CD: <a href="https://github.com/BitCurator/bitcurator-distro/wiki/Releases">https://github.com/BitCurator/bitcurator-distro/wiki/Releases</a></li>
173+
<li>Current release of VirtualBox: <a href="https://www.virtualbox.org/wiki/Downloads">https://www.virtualbox.org/wiki/Downloads</a></li>
174+
<li>The VirtualBox Extension Pack <strong>must</strong> be installed on the host for shared folder support, USB 2.0/3.0 support, and support for some NVMe SSDs. Once you’ve installed VirtualBox, use the link below the main download on VirtualBox download site to install the Extension Pack on your host.</li>
175+
</ul>
176+
<h4 id="step-2-unpack-the-bitcurator-virtual-machine">Step 2: Unpack the BitCurator Virtual Machine</h4>
177+
<p>The BitCurator Virtual Machine is packaged as a tar archive and compressed with gzip. The file will look something like: <strong>“BitCurator-X.X.X.tar.gz”</strong></p>
156178
<p>On a Mac (OS X 10.10 or later) or Linux host machine, you can simply double-click on the file to unpack the contents.</p>
157179
<p>On a Windows machine, you may need a 3rd party utility such as 7-zip: <a href="https://www.7-zip.org/download.html">https://www.7-zip.org/download.html</a></p>
158180
<p>When using 7-zip, you’ll need to unpack the .tar.gz file. Right click on the .tar.gz file and select “Extract here…” to extract the .tar file. Then right click on the .tar file and select “Extract here…” again. This will extract a directory containing the BitCurator virtual machine disk image (.vbox) and configuration (.vdi) files.</p>
@@ -163,33 +185,39 @@ <h3 id="installation-instructions">Installation Instructions</h3>
163185
</ul>
164186
<p>Copy this directory to a location of your choosing (inside the “VirtualBox VMs” directory in your home directory is a good place), and start up VirtualBox.</p>
165187
<p>If you’ve never created or used a VM in VirtualBox before, you won’t have a “VirtualBox VMs” directory. Don’t worry – just remember where you extracted the BitCurator directory.</p>
166-
<p>Step 3: Open Oracle VM VirtualBox ManagerOnce you’ve installed VirtualBox and the VirtualBox extension pack, start up VirtualBox. If you’ve never used VirtualBox before, your list of machines (on the left) will be blank.</p>
188+
<h4 id="step-3-open-oracle-vm-virtualbox-manager">Step 3: Open Oracle VM VirtualBox Manager</h4>
189+
<p>Once you’ve installed VirtualBox and the VirtualBox extension pack, start up VirtualBox. If you’ve never used VirtualBox before, your list of machines (on the left) will be blank.</p>
167190
<p>You may need to right-click on the VirtualBox icon and select “Run as Administrator”. Windows machines with certain administrative controls may prevent you from accessing USB devices (or lock out control of the mouse and keyboard) otherwise.</p>
168191
<p><em>VirtualBox Manager in Windows:</em></p>
169192
<p><em>VirtualBox Manager in macOS:</em></p>
170-
<p>Step 4: Add a Virtual MachineFrom the menu bar, select the menu item “Machine -&gt; Add…”</p>
193+
<h4 id="step-4-add-a-virtual-machine">Step 4: Add a Virtual Machine</h4>
194+
<p>From the menu bar, select the menu item “Machine -&gt; Add…”</p>
171195
<p>Navigate to the folder containing .vbox file that you extracted.</p>
172196
<p>Choose that file, and the Virtual Machine should appear in the list within the manager.</p>
173197
<p><em>Adding a machine (VirtualBox in Windows):</em></p>
174198
<p><em>Adding a machine (VirtualBox in macOS):</em></p>
175-
<p>Step 5: Configure RAM and ProcessorsClick on the Settings icon, and select the system tab.</p>
199+
<h4 id="step-5-configure-ram-and-processors">Step 5: Configure RAM and Processors</h4>
200+
<p>Click on the Settings icon, and select the system tab.</p>
176201
<p><strong>We recommend a minimum of 4096 MB RAM and 2 processors assigned to the VM.</strong></p>
177202
<p>You may wish to change the RAM and number of processors depending on the hardware that you’re running on. For best results, select the largest number in the “green” areas for each.</p>
178203
<p>Two or more processors assigned for VirtualBox are need to support drag-and-drop functionality.</p>
179204
<p><em>Configuring the VM (VirtualBox in Windows):</em></p>
180205
<p><em>Configuring the VM (VirtualBox in macOS):</em></p>
181-
<p>Step 6: Enable USB Device CaptureBitCurator depends on a VirtualBox device filter to capture USB devices. In macOS, you’ll find this filter under the USB tab of the “Ports” icon under “Settings”.</p>
206+
<h4 id="step-6-enable-usb-device-capture">Step 6: Enable USB Device Capture</h4>
207+
<p>BitCurator depends on a VirtualBox device filter to capture USB devices. In macOS, you’ll find this filter under the USB tab of the “Ports” icon under “Settings”.</p>
182208
<p>In Windows, you’ll find it in the “USB” tab in settings. You don’t need to do anything here, unless you don’t see an entry under “USB Device Filters”.</p>
183209
<p><strong>If you don’t see an entry, select the USB 3.0 radio button, and then create a new filter by clicking on the blue icon to the right of the list.</strong></p>
184210
<p>If you don’t need access to USB devices (for example, if you plan to do analysis of existing born-digital data but no disk imaging), you can delete this filter.</p>
185211
<p><em>USB Filters (VirtualBox in Windows):</em></p>
186212
<p><em>USB Filters (VirtualBox in macOS):</em></p>
187-
<p>Step 7: Setup Shared FoldersIf you wish to move processed materials <strong>back to your host machine</strong> from the BitCurator VM, you can set up a shared folder that both the host and the VM can write to.</p>
213+
<h4 id="step-7-setup-shared-folders">Step 7: Setup Shared Folders</h4>
214+
<p>If you wish to move processed materials <strong>back to your host machine</strong> from the BitCurator VM, you can set up a shared folder that both the host and the VM can write to.</p>
188215
<p>In the Shared Folders tab, click the folder with the green “plus” on it to choose a folder on your host machine to share.</p>
189216
<p>Select “Automount” but not “Read Only”. When the machine is booted, the folder will appear in the “Shared Folders and Media” folder on the desktop in the VM.</p>
190217
<p><em>Shared Folders (VirtualBox in Windows):</em></p>
191218
<p><em>Shared Folders (VirtualBox in macOS):</em></p>
192-
<p>Step 8: Starting the BitCurator Environment (VM)Click on the green “Start” arrow in the Oracle VM VirtualBox Manager screen to start the BitCurator environment.</p>
219+
<h4 id="step-8-starting-the-bitcurator-environment-vm">Step 8: Starting the BitCurator Environment (VM)</h4>
220+
<p>Click on the green “Start” arrow in the Oracle VM VirtualBox Manager screen to start the BitCurator environment.</p>
193221
<p>You will see a startup screen, and then the BitCurator environment will boot and automatically log in.</p>
194222
<p>If you encounter a menu screen on boot, simply hit the Return key to continue.</p>
195223
<p>If you see an error message mentioning virtualization extensions, or “Intel VT-x”, your host machine’s BIOS does not have the VT-x extensions enabled. You’ll need to reboot your computer, holding down “Del” (or “Esc”, or the “ThinkPad” button, depending on your machine). Once you’re in the BIOS, locate the correct menu entry and enable the “Intel Virtualization Extensions”.</p>

site/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,5 +193,5 @@ <h2 id="licenses">Licenses</h2>
193193

194194
<!--
195195
MkDocs version : 1.5.3
196-
Build Date UTC : 2023-11-27 22:08:07.036117+00:00
196+
Build Date UTC : 2024-03-20 19:23:27.852152+00:00
197197
-->

site/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

site/sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)