Files
threshold/website/content/docs/oss/installing/run-and-login.mdx
T
eea5e80fa2 Update documentation with new authenticate usage on the CLI (#2865)
* docs: update deploy-and-login getting started guide with new authenticate usage

* docs: update api-clients/cli.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/manage-users-groups.mdx to remove login-name flag when using authenticate

* docs: update common-workflows/workflow-ssh-proxycommand.mdx with new short form usage of authenticate command when using the primary auth method in the global scope

* docs: update oss/installing/no-gen-resources.mdx to remove login-name usage in authenticate command

* docs: update oss/installing/run-and-login.mdx with short form usage of boundary authenticate

* docs: fix tabs

* docs: fix numbering

* Apply batch of suggestions from code review

Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>

* docs: fix code blocks

* fixes code blocks

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
2023-02-07 10:40:31 -05:00

116 lines
3.2 KiB
Plaintext

---
layout: docs
page_title: Run and Login
description: |-
How to run Boundary services in dev mode and login for the first time.
---
# Run and Login to Boundary
To start Boundary in dev mode:
```shell-session
$ boundary dev
```
## Login to Boundary
Boundary uses a predictable login name (`admin`) and password (`password`) in
dev mode. These can be overridden, or randomly generated, with flags to
`boundary dev`. The auth method resource in the global scope is set as the primary auth method for that scope. This allows you to omit the auth method ID when authenticating, enabling the short-form `boundary authenticate`:
<Tabs>
<Tab heading="CLI">
```shell-session
$ boundary authenticate
Please enter the login name (it will be hidden):
Please enter the password (it will be hidden):
```
If you are on Windows or macOS, the system password store will be used to store
the new token. On any other operating system, you may get an error indicating
that the token could not be stored. Boundary defaults to using
[pass](https://www.passwordstore.org/) on these machines, which uses [GNU
Privacy Guard](https://gnupg.org/) to encrypt values. If it is not available,
the token will be displayed and can be stored in a system of your choice and
passed in via the `BOUNDARY_TOKEN` environment variable.
It is recommended to make use of `pass` or another alternative (such as any
implementation of the freedesktop.org Secret Service feature). Installation and
configuration of `pass` or other alternatives is beyond the scope of this
article; consult the documentation for `pass` or your specific OS distribution
help pages.
</Tab>
<Tab heading="Admin Console">
To authenticate to the Admin UI, open
[http://127.0.0.1:9200](http://127.0.0.1:9200) in a browser and enter the login
name and password:
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602260993-boundary-clickthrough-getting-started-run-and-login.mp4"
/>
</video>
</Tab>
<Tab heading="Desktop Client">
<p>
To authenticate using the Boundary desktop client, launch Boundary desktop client
and connect to boundary to using [http://127.0.0.1:9200](http://127.0.0.1:9200)
and enter the login name and password:
<video
muted
playsInline
autoPlay
loop
class="boundary-clickthrough-video boundary-clickthrough-desktop-video"
>
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1613612831-boundary-desktop-clickthrough-authenticate-v1-0-0.mp4"
/>
</video>
</p>
</Tab>
<Tab heading="Terraform">
You can also use these overrides to configure the [Terraform provider for
Boundary](https://github.com/hashicorp/terraform-provider-boundary):
```hcl
provider "boundary" {
base_url = "http://127.0.0.1:9200"
auth_method_id = "ampw_1234567890"
auth_method_username = "admin"
auth_method_password = "password"
}
```
Note in the example above we're setting `base_url` to `http` and not `https` as
the Boundary server does not use TLS in development mode.
</Tab>
</Tabs>
## Next Steps
See [connecting to your first
target](/boundary/docs/oss/installing/connect-to-dev-target) for how to use Boundary to
run your first SSH session.