Skip to content

Commit 675244c

Browse files
committed
Updated README.md for base image
1 parent f13048c commit 675244c

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

fhooe-webdev-base/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
# fhooe-webdev-base – A Vagrantfile for Developing the fhooe-webdev Vagrant Box
22

3-
This directory provides the Vagrantfile that configures the [fhooe/fhooe-webdev box](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev). It is based on the [bento/ubuntu-21.10 box](https://app.vagrantup.com/bento/boxes/ubuntu-21.10) and adds Apache2, PHP 8.1, MariaDB 10.7, as well as additional tools and scripts.
3+
This directory provides the Vagrantfile that configures the [fhooe/fhooe-webdev box](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev). It is based on the [bento/ubuntu-22.04 box](https://app.vagrantup.com/bento/boxes/ubuntu-22.04) and adds Apache2, PHP 8.2, MariaDB 10.11, and additional tools and scripts.
44

5-
This Vagrantfile is solely meant for developing the final Vagrant box. Although you can use for web development, provisioning the image takes some time and is most likely not very convenient.
5+
This Vagrantfile is solely meant for developing the final Vagrant box. Although you can use it for web development, provisioning the image takes time and is most likely inconvenient.
66

7-
## Installation of software and prerequisites
7+
## Installation of Software and Prerequisites
88

99
To use this environment, you will need [VirtualBox](https://www.virtualbox.org/) and [Vagrant](https://www.vagrantup.com/). For them to work on your machine, make sure the following prerequisites are fulfilled:
1010

1111
* Virtualization is activated in BIOS.
1212
* 10 GB of disk space is available locally. If possible, use an SSD for better performance.
13-
* [Windows] At least VirtualBox 6.1.26 under Windows 10 21H1 or Hyper-V deactivated when using an earlier version.
14-
* [Mac OS X] Make sure, VirtualBox has the necessary permissions. Go to "System Settings -> Security -> Allow Virtual Box".
13+
* [Windows] At least VirtualBox 6.1.26 under Windows 10 21H1 or Hyper-V deactivated when using an earlier version. Version 7 and the latest version of Windows are recommended.
14+
* [Mac OS X] Make sure VirtualBox has the necessary permissions. Go to "System Settings -> Security -> Allow Virtual Box".
1515

1616
Then install the required software in the following order:
1717

18-
1. Download the latest version of VirtualBox from <https://www.virtualbox.org/wiki/Downloads> and install. Alternatively, when running Windows, use [Chocolatey](https://chocolatey.org/): `choco install virtualbox`.
19-
2. Download the latest version of Vagrant from <https://www.vagrantup.com/downloads.html> and install. With Chocolatey on Windows run `choco install vagrant`.
18+
1. Download the latest version of VirtualBox from <https://www.virtualbox.org/wiki/Downloads> and install it. Alternatively, when running Windows, use [Chocolatey](https://chocolatey.org/): `choco install virtualbox`.
19+
2. Download the latest version of Vagrant from <https://www.vagrantup.com/downloads.html> and install it. With Chocolatey on Windows, run `choco install vagrant`.
2020
3. Reboot your computer for all changes to take effect.
2121

22-
## How to use
22+
## How to Use
2323

2424
Follow these steps to build a new fhooe/fhooe-webdev base box and distribute it on Vagrant Cloud.
2525

26-
### Downloading and customizing
26+
### Downloading andCustomizing
2727

2828
Download or clone the [fhooe-webdev](https://github.com/Digital-Media/fhooe-webdev) repository to a location of your choice on your computer.
2929

30-
Make all the changes in the Vagrantfile of the `fhooe-webdev-base` directory. Make sure to document everything in the Vagrantfile, if possible, use `echo` statements to show what you are doing.
30+
Make all the changes in the Vagrantfile of the `fhooe-webdev-base` directory. Make sure to document everything in the Vagrantfile; if possible, use `echo` statements to show what you are doing.
3131

32-
To test everything, switch to the directory where you cloned/downloaded the repository, and select the development subdirectory, e.g., `cd <path-to>/fhooe-webdev/fhooe-webdev-base`. Then run `vagrant up`. This will download the [bento/ubuntu-21.10 box](https://app.vagrantup.com/bento/boxes/ubuntu-21.10) (a minimal Ubuntu image) from Vagrant Cloud, and run all the provisioning steps from the Vagrantfile. Finally, the machine is run in headless mode. Use `vagrant ssh` to connect to the box and make sure everything is running and configured as planned.
32+
To test everything, switch to the directory where you cloned/downloaded the repository, and select the development subdirectory, e.g., `cd <path-to>/fhooe-webdev/fhooe-webdev-base`. Then run `vagrant up`. This will download the [bento/ubuntu-22.04 box](https://app.vagrantup.com/bento/boxes/ubuntu-22.04) (a minimal Ubuntu image) from Vagrant Cloud, and run all the provisioning steps from the Vagrantfile. Finally, the machine is run in headless mode. Use `vagrant ssh` to connect to the box and ensure everything is running and configured as planned.
3333

34-
### Creating the fhooe/fhooe-webdev box
34+
### Creating the fhooe/fhooe-webdev Box
3535

3636
If the image has started successfully and all provisioning has worked out as planned, you can package the current state of the machine into a Vagrant box file, which can then be uploaded to Vagrant Cloud as a new release.
3737

38-
#### Cleaning up the image
38+
#### Cleaning up the Image
3939

4040
Before packaging, clean up the image to remove unnecessary files. SSH into the box using `vagrant ssh` and run the subsequent commands:
4141

@@ -58,7 +58,7 @@ Finally, the bash history is cleared and the SSH connection is exited:
5858
$ cat /dev/null > ~/.bash_history && history -c && exit
5959
```
6060

61-
#### Packaging the Vagrant box
61+
#### Packaging the Vagrant Box
6262

6363
The currently running (and now cleaned) machine is promptly packaged into a Vagrant box file so it can be uploaded to Vagrant Cloud and made available for distribution.
6464

@@ -70,7 +70,7 @@ Replace `X.Y.Z` with the version number you're planning to release. Frankly, the
7070

7171
### Uploading to Vagrant Cloud
7272

73-
Go to the [fhooe/fhooe-webdev site](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev) on Vagrant Cloud, log in and select [New Version](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev/versions/new).
73+
Go to the [fhooe/fhooe-webdev site](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev) on Vagrant Cloud, login, and select [New Version](https://app.vagrantup.com/fhooe/boxes/fhooe-webdev/versions/new).
7474

7575
Add a version number in the RubyGems versioning scheme (e.g. 1.2.3). Do *not* precede the version number with a "v" (e.g. v1.2.3). Also, add a description for this version. This functions as release notes, so include what has changed in this release. Then click "Create version".
7676

@@ -80,7 +80,7 @@ Once the version has been created, select "Add a provider" to add the actual box
8080
PS> Get-FileHash -Path .\fhooe-webdev-vX.Y.Z.box -Algorithm SHA512 | Format-List
8181
```
8282

83-
On Linux and Mac OS X use this in your terminal:
83+
On Linux and macOS use this in your terminal:
8484

8585
```shell
8686
$ shasum -a512 fhooe-webdev-vX.Y.Z.box

0 commit comments

Comments
 (0)