From 76da1924fe79f9668c9fe524cf80570e8f2f0cdd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= <gina@foosel.net>
Date: Tue, 12 Oct 2021 17:49:13 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20config=20action=20par?=
 =?UTF-8?q?ameter?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 1687de0..40fc4f4 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,12 @@ EDITBASE_IMAGE_ENLARGEROOT=100
 EDITBASE_IMAGE_RESIZEROOT=20
 ```
 
+This can be achieved through `-v /path/to/config.local:/CustoPiZer/config.local` in the docker command, e.g.
+
+```
+docker run --rm --privileged -v /path/to/workspace:/CustoPiZer/workspace -v /path/to/config.local:/CustoPiZer/config.local ghcr.io/octoprint/custopizer:latest
+```
+
 ### Example
 
 Place this in `workspace/scripts/01-update-octoprint`:
@@ -116,6 +122,18 @@ inside the script context, e.g.:
 >
 >     environment: "{ 'OCTOPRINT_VERSION': '${{ env.OCTOPRINT_VERSION }}' }"
 
+If you need to provide a custom `config.local`, e.g. to override filesystem extending/shrinking,
+you can do that via the `config` parameter:
+
+``` yaml
+- name: Run CustoPiZer
+  uses: OctoPrint/CustoPiZer@main
+  with:
+    workspace: "${{ github.workspace }}/build"
+    scripts:  "${{ github.workspace }}/scripts"
+    config: "${{ github.workspace }}/config.local"
+```
+
 For a complex example usage that also includes repository dispatch, creating releases and attaching assets, take a look at the scripts and workflow of [OctoPrint/OctoPi-UpToDate](https://github.com/OctoPrint/OctoPi-UpToDate).
 
 ## Writing customization scripts