docs: add conf environment variables description (#438)

When setting up the provider I required ENV variable setup but could not find those in the docs. Signed-off-by: anryko <[email protected]>
goharbor · Jun 3, 2024 · 115d4f7 · 115d4f7
1 parent dff583d
commit 115d4f7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -20,6 +20,10 @@ description: |-
 
 ### Optional
 
-- `api_version` (Number) Choose which version of the api you would like to use 1 or 2. Default is `2`
+- `api_version` (Number) Choose which version of the api you would like to use 1 or 2 (default is 2)
 - `bearer_token` (String) The bearer token to be used to access harbor. Will take precedence over username and password if set
 - `insecure` (Boolean) Choose to ignore certificate errors
+
+### Environment variables
+
+The provider can also be configured via environment variables: `HARBOR_URL`, `HARBOR_USERNAME`, `HARBOR_PASSWORD`.
diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -24,6 +24,10 @@ For example, the {{ .SchemaMarkdown }} template can be used to replace manual sc
 
 ### Optional
 
-- `api_version` (Number) Choose which version of the api you would like to use 1 or 2. Default is `2`
+- `api_version` (Number) Choose which version of the api you would like to use 1 or 2 (default is 2)
 - `bearer_token` (String) The bearer token to be used to access harbor. Will take precedence over username and password if set
 - `insecure` (Boolean) Choose to ignore certificate errors
+
+### Environment variables
+
+The provider can also be configured via environment variables: `HARBOR_URL`, `HARBOR_USERNAME`, `HARBOR_PASSWORD`.