Also add CLI "how to" instructions

moderneinc · Sep 3, 2024 · 658085d · 658085d
1 parent cecb07f
commit 658085d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/user-documentation/moderne-cli/how-to-guides/README.md b/user-documentation/moderne-cli/how-to-guides/README.md
@@ -5,6 +5,7 @@
 * [How to install and configure the CLI in an air-gapped environment](air-gapped-cli-install.md)
 * [How to execute user-supplied commands on a list of repositories](execute-user-supplied-commands.md)
 * [How to clone and synchronize organizations](clone-and-sync.md)
+* [On prem source code management (SCM) server configuration](on-prem-scm-config.md)
 * [Configuring build steps](build-steps.md)
 * [Configuring build partitions](build-partitions.md)
 * [Bazel support](bazel-support.md)
diff --git a/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md b/user-documentation/moderne-cli/how-to-guides/on-prem-scm-config.md
@@ -0,0 +1,20 @@
+# On prem source code management (SCM) server configuration
+
+In order for Moderne DX to correctly map repository clone URLs to the right origin and path we need to know the base URL(s) for your SCM server. With SaaS SCM services like GitHub, GitLab, Bitbucket (cloud) and AzureDevOps these are well known URLs, to use these no extra configuration is required.
+However, for any on-prem SCM servers we do need to configure the type, base URL and any alternate URLs that are used to access the server. 
+
+## Configure your on prem SCM servers
+
+You can use the following command to configure a new SCM server:
+
+```shell
+mod config scm add Bitbucket https://bitbucket.example.com/stash --alternate-url ssh://bitbucket.example.com:7999 --alternate-url http://bitbucket.example.com:8080/stash
+```
+
+If a server with this type and base URL already exists, it will be updated with the supplied alternate URLs.
+
+To remove a configuration you can use:
+
+```shell
+mod config scm remove Bitbucket https://bitbucket.example.com/stash
+```