From 5303f6a5ca0ffe3c5cef4ecbabbfa1bd4e4aef56 Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@thegeeklab.de>
Date: Wed, 21 Dec 2022 10:49:07 +0100
Subject: [PATCH] docs: add example for custom registires (#74)

---
 .dictionary             |  1 +
 _docs/content/_index.md | 22 ++++++++++++++++++++++
 _docs/data/data.yaml    |  4 +++-
 3 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/.dictionary b/.dictionary
index b516618..82e2e9e 100644
--- a/.dictionary
+++ b/.dictionary
@@ -10,3 +10,4 @@ json
 config
 host:ip
 multiarch
+DockerHub
diff --git a/_docs/content/_index.md b/_docs/content/_index.md
index d52f91d..048573a 100644
--- a/_docs/content/_index.md
+++ b/_docs/content/_index.md
@@ -50,6 +50,28 @@ steps:
 <!-- spellchecker-enable -->
 <!-- prettier-ignore-end -->
 
+### Examples
+
+**Push to other registries than DockerHub:**
+
+If the created image is to be pushed to registries other than the default DockerHub, it is necessary to set `registry` and `repo` as fully-qualified name.
+
+```YAML
+kind: pipeline
+name: default
+
+steps:
+  - name: docker
+    image: thegeeklab/drone-docker
+    privileged: true
+    settings:
+      registry: ghcr.io
+      username: octocat
+      password: secret-access-token
+      repo: ghcr.io/octocat/example
+      tags: latest
+```
+
 ## Build
 
 Build the binary with the following command:
diff --git a/_docs/data/data.yaml b/_docs/data/data.yaml
index fb25936..f115805 100644
--- a/_docs/data/data.yaml
+++ b/_docs/data/data.yaml
@@ -147,7 +147,9 @@ properties:
     required: false
 
   - name: repo
-    description: Repository name for the image.
+    description: |
+      Repository name for the image. If the image is to be pushed to registries other than the default DockerHub,
+      it is necessary to set `repo` as fully-qualified name.
     type: string
     required: false