Fixed the deprecation warning in the CI pipelines. Added a section in…

… the README for overloading the images.
sk4la · Nov 13, 2022 · 8b8d20a · 8b8d20a
1 parent 91aae6a
commit 8b8d20a
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 4 deletions.
diff --git a/.github/workflows/dwarf2json.yml b/.github/workflows/dwarf2json.yml
@@ -50,7 +50,7 @@ jobs:
           build-args: |
             ALPINE_VERSION=${{ env.DOCKER_TAG_ALPINE }}
             GIT_TAG_DWARF2JSON=${{ env.GIT_TAG_DWARF2JSON }}
-            PRODUCT_BUILD_COMMIT=${{ env.GITHUB_SHA }}
+            PRODUCT_BUILD_COMMIT=${{ github.sha }}
             PRODUCT_BUILD_DATE=${{ steps.date.outputs.date }}
 
       - name: Update Docker Hub repository description for ${{ secrets.DOCKER_HUB_USERNAME }}/dwarf2json

diff --git a/.github/workflows/volatility.yml b/.github/workflows/volatility.yml
@@ -52,7 +52,7 @@ jobs:
             ALPINE_VERSION=${{ env.DOCKER_TAG_ALPINE }}
             GIT_TAG_PYTHON_YARA=${{ env.GIT_TAG_PYTHON_YARA }}
             GIT_TAG_VOLATILITY=${{ env.GIT_TAG_VOLATILITY }}
-            PRODUCT_BUILD_COMMIT=${{ env.GITHUB_SHA }}
+            PRODUCT_BUILD_COMMIT=${{ github.sha }}
             PRODUCT_BUILD_DATE=${{ steps.date.outputs.date }}
 
       - name: Update Docker Hub repository description for ${{ secrets.DOCKER_HUB_USERNAME }}/volatility

diff --git a/.github/workflows/volatility3-edge.yml b/.github/workflows/volatility3-edge.yml
@@ -51,7 +51,7 @@ jobs:
             GIT_TAG_JPCERT_SYMBOLS=${{ env.GIT_TAG_JPCERT_SYMBOLS }}
             GIT_TAG_PYTHON_YARA=${{ env.GIT_TAG_PYTHON_YARA }}
             GIT_TAG_VOLATILITY3=${{ env.GIT_TAG_VOLATILITY3 }}
-            PRODUCT_BUILD_COMMIT=${{ env.GITHUB_SHA }}
+            PRODUCT_BUILD_COMMIT=${{ github.sha }}
             PRODUCT_BUILD_DATE=${{ steps.date.outputs.date }}
 
       - name: Update Docker Hub repository description for ${{ secrets.DOCKER_HUB_USERNAME }}/volatility3

diff --git a/.github/workflows/volatility3.yml b/.github/workflows/volatility3.yml
@@ -54,7 +54,7 @@ jobs:
             GIT_TAG_JPCERT_SYMBOLS=${{ env.GIT_TAG_JPCERT_SYMBOLS }}
             GIT_TAG_PYTHON_YARA=${{ env.GIT_TAG_PYTHON_YARA }}
             GIT_TAG_VOLATILITY3=${{ env.GIT_TAG_VOLATILITY3 }}
-            PRODUCT_BUILD_COMMIT=${{ env.GITHUB_SHA }}
+            PRODUCT_BUILD_COMMIT=${{ github.sha }}
             PRODUCT_BUILD_DATE=${{ steps.date.outputs.date }}
 
       - name: Update Docker Hub repository description for ${{ secrets.DOCKER_HUB_USERNAME }}/volatility3

diff --git a/README.md b/README.md
@@ -219,6 +219,33 @@ docker image list
 
 </details>
 
+<details>
+  <summary>Example #4: Overloading the Docker images to fit your needs</summary>
+
+### Example #4: Overloading the Docker images to fit your needs
+
+If you feel that the original image lacks useful stuff, you can either suggest it by [submitting a ticket](https://github.com/sk4la/volatility3-docker/issues) or you can overload the base image yourself in order to adapt it to your needs.
+
+In order to do this, simply create a new `Dockerfile` based off one of the images from this repository—for example `sk4la/volatility3`:
+
+```docker
+FROM sk4la/volatility3
+
+USER root
+
+RUN apk add $STUFF
+
+USER unprivileged
+```
+
+> By default, all of the images provided in this repository do not run as `root`—they run as the `unprivileged` user. For actions necessitating super-user privileges, it is necessary to switch user temporarily, as shown in the example.
+
+Then, build the image by executing the `docker image build --tag volatility3-overloaded .` command. The newly-created Docker image should then appear in the local repository.
+
+> Please have a look at the [original `Dockerfile`](src/volatility3/Dockerfile) if you need a hint on how everything is setup.
+
+</details>
+
 ## Support
 
 In case you encounter a problem or want to suggest a new feature relative to these Docker images, please [submit a ticket](https://github.com/sk4la/volatility3-docker/issues). [Pull requests](https://github.com/sk4la/volatility3-docker/pulls) are also greatly appreciated.