Skip to content

Commit

Permalink
[DOC-9058] Add --vanity-name flag to ccloud docs (#17990)
Browse files Browse the repository at this point in the history
* Add --vanity-name flag to ccloud docs

Co-authored-by: Matt Linville (he/him) <[email protected]>
Co-authored-by: Ryan Kuo <[email protected]>
  • Loading branch information
3 people authored Oct 20, 2023
1 parent a2ad60b commit b102d1d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/current/cockroachcloud/ccloud-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,20 @@ If you are a member of more than one [CockroachDB Cloud organization](https://ww

{% include_cached copy-clipboard.html %}
~~~ shell
ccloud auth login --org <organization label>
ccloud auth login --org {organization-label}
~~~

The organization label is found on the **Settings** page of the CockroachDB Cloud Console.

If your organization has a custom URL, use the `--vanity-name` flag to log in:

{% include_cached copy-clipboard.html %}
~~~ shell
ccloud auth login --vanity-name {custom-organization-name}
~~~

Replace `{custom-organization-name}` with the portion of the custom sign-in URL that follows `/login/`. Do not pass the full custom sign-in URL.

### Log in to CockroachDB Cloud on a headless server

If you are using `ccloud` on a headless machine, use the `--no-redirect` flag to log in. This allows you to log in to CockroachDB Cloud on a different machine, retrieve an authorization code, and enter the code on the headless machine so `ccloud` can complete authentication.
Expand Down

0 comments on commit b102d1d

Please sign in to comment.