You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fhooe-webdev-base/README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,41 @@
1
1
# fhooe-webdev-base – A Vagrantfile for Developing the fhooe-webdev Vagrant Box
2
2
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.
4
4
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.
6
6
7
-
## Installation of software and prerequisites
7
+
## Installation of Software and Prerequisites
8
8
9
9
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:
10
10
11
11
* Virtualization is activated in BIOS.
12
12
* 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".
15
15
16
16
Then install the required software in the following order:
17
17
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`.
20
20
3. Reboot your computer for all changes to take effect.
21
21
22
-
## How to use
22
+
## How to Use
23
23
24
24
Follow these steps to build a new fhooe/fhooe-webdev base box and distribute it on Vagrant Cloud.
25
25
26
-
### Downloading and customizing
26
+
### Downloading andCustomizing
27
27
28
28
Download or clone the [fhooe-webdev](https://github.com/Digital-Media/fhooe-webdev) repository to a location of your choice on your computer.
29
29
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.
31
31
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.
33
33
34
-
### Creating the fhooe/fhooe-webdev box
34
+
### Creating the fhooe/fhooe-webdev Box
35
35
36
36
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.
37
37
38
-
#### Cleaning up the image
38
+
#### Cleaning up the Image
39
39
40
40
Before packaging, clean up the image to remove unnecessary files. SSH into the box using `vagrant ssh` and run the subsequent commands:
41
41
@@ -58,7 +58,7 @@ Finally, the bash history is cleared and the SSH connection is exited:
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.
64
64
@@ -70,7 +70,7 @@ Replace `X.Y.Z` with the version number you're planning to release. Frankly, the
70
70
71
71
### Uploading to Vagrant Cloud
72
72
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).
74
74
75
75
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".
76
76
@@ -80,7 +80,7 @@ Once the version has been created, select "Add a provider" to add the actual box
0 commit comments