Initial Commit

README.md

@@ -1,3 +1,29 @@
 # Utility-Image-Builder
 
-A template repo for maintaining base Docker images in my private registry.
+A template repo for maintaining base Docker images in my private registry.
+
+> NOTE: The steps below are not for this repo, but for those using it as a template.
+
+## Bootstrapping
+> If needed, steps starting with `[sudo]` require elevated permissions.
+
+> Go through the entire process before committing to the main branch.
+
+1. Create a new repository by clicking the "Use this template" button on the template repo page.
+1. Configure the new repo settings. At the bottom, select `Template Items` -> `Git Content`.
+1. Create the new repo.
+1. Pull new repo to local PC.
+1. [sudo] Give the setup script permission to execute:
+    ```bash
+    chmod +x template/setup.sh
+    ```
+1. [sudo] Run the start script and fill in the prompts:
+    ```bash
+    ./template/setup.sh
+    ```
+1. Change the Dockerfile as desired. NOTE: Committing before doing this will still build an image...
+1. Populate the `config.json`. This is to make it easy to do version management
+1. Commit to main. If you are committing to an organization linked to the Jenkins server the image will automatically be build for
+the architecture you specified.
+
+> Note that the bootstrapped repo has to be in a organization where the Jenkins user has visibility, and the organization must be configured and linked to the Jenkins server.