docs: added environment variables documentation (#8680)

* added environment variables page Signed-off-by: Hari Sekhon <[email protected]> * added Environment Variables page to User Guide Signed-off-by: Hari Sekhon <[email protected]> * reformatted table cells as multiline for clarity Signed-off-by: Hari Sekhon <[email protected]> * fixed typo Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]>
argoproj · Jun 13, 2022 · f414a8e · f414a8e
1 parent 91aefab
commit f414a8e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/user-guide/environment-variables.md b/docs/user-guide/environment-variables.md
@@ -0,0 +1,9 @@
+# Environment Variables
+
+The following environment variables can be used with `argocd` CLI:
+
+| Environment Variable | Description |
+| --- | --- |
+| `ARGOCD_SERVER` | the address of the ArgoCD server without `https://` prefix <br> (instead of specifying `--server` for every command) <br> eg. `ARGOCD_SERVER=argocd.mycompany.com` if served through an ingress with DNS |
+| `ARGOCD_AUTH_TOKEN` | the ArgoCD `apiKey` for your ArgoCD user to be able to authenticate |
+| `ARGOCD_OPTS` | command-line options to pass to `argocd` CLI <br> eg. `ARGOCD_OPTS="--grpc-web"` |
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -129,6 +129,7 @@ nav:
   - user-guide/compare-options.md
   - user-guide/sync-options.md
   - user-guide/parameters.md
+  - user-guide/environment-variables.md
   - user-guide/build-environment.md
   - user-guide/tracking_strategies.md
   - user-guide/resource_tracking.md