From ba216f894b1929b7964fd62229db047aa0c74e06 Mon Sep 17 00:00:00 2001 From: Jeff Mitchell Date: Fri, 25 Sep 2020 19:38:53 -0400 Subject: [PATCH] Update docs and default address --- api/client.go | 4 +- .../content/docs/getting-started/index.mdx | 2 +- .../docs/getting-started/run-and-login.mdx | 46 +++++++++---------- 3 files changed, 24 insertions(+), 28 deletions(-) diff --git a/api/client.go b/api/client.go index a2b79cfdd9..6131b3be26 100644 --- a/api/client.go +++ b/api/client.go @@ -131,13 +131,13 @@ type TLSConfig struct { // DefaultConfig returns a default configuration for the client. It is // safe to modify the return value of this function. // -// The default Addr is https://127.0.0.1:9200, but this can be overridden by +// The default Addr is http://127.0.0.1:9200, but this can be overridden by // setting the `BOUNDARY_ADDR` environment variable. // // If an error is encountered, this will return nil. func DefaultConfig() (*Config, error) { config := &Config{ - Addr: "https://127.0.0.1:9200", + Addr: "http://127.0.0.1:9200", HttpClient: cleanhttp.DefaultPooledClient(), Timeout: time.Second * 60, TLSConfig: &TLSConfig{}, diff --git a/website/content/docs/getting-started/index.mdx b/website/content/docs/getting-started/index.mdx index ba75bd1573..ad36ed5e38 100644 --- a/website/content/docs/getting-started/index.mdx +++ b/website/content/docs/getting-started/index.mdx @@ -37,6 +37,6 @@ These components should all be considered ephemeral - no data persistence occurs 1. A static [host](/docs/concepts/domain-model/hosts) and [host set](/docs/concepts/domain-model/host-sets) with default ID's of `hst_1234567890` and `hsst_1234567890` respectively. 1. A TCP [target](/docs/concepts/domain-model/targets) with a default ID of `ttcp_1234567890`. -All of the default ID suffixes are overridable as well as several other dev mode configurations. To see a complete list of these override flags, consult `boundary dev -h`. +The default ID suffixes are overridable or can be randomly generated, and there are many other dev mode controls. To see a complete list of these override flags, consult `boundary dev -h`. If you plan on provisioning a large number of resources in dev mode, it's strongly recommended that users leverage our [Terraform Provider for Boundary](https://github.com/hashicorp/terraform-provider-boundary) for managing configuration of Boundary. This will simplify starting up and shutting down your Boundary dev instance. diff --git a/website/content/docs/getting-started/run-and-login.mdx b/website/content/docs/getting-started/run-and-login.mdx index 181069d0ee..61bf088b78 100644 --- a/website/content/docs/getting-started/run-and-login.mdx +++ b/website/content/docs/getting-started/run-and-login.mdx @@ -14,55 +14,51 @@ To start Boundary in dev mode: boundary dev ``` -When the Boundary services start, you'll get the randomly generated login name and password in the output. To make things even more simple, you can override these values with hard coded ones instead: - -```bash -boundary dev \ - -password=foofoofoo \ - -login-name=foo -``` - ## Login to Boundary -You can use the values from the above example to authenticate. +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`. -For CLI users, you can override using flags: +From the CLI: ``` -# Boundary uses http not https in dev mode -boundary authenticate password --addr='http://127.0.0.1:9200' \ - -login-name=foo \ - -password foofoofoo \ +boundary authenticate password \ + -login-name=admin \ + -password password \ -auth-method-id=ampw_1234567890 ``` -The authenticate to the Admin UI, open [http://127.0.0.1:9200](http://127.0.0.1:9200) in a browser and enter the hard coded login name and password: +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: ![](/img/login-dev-mode.png) -You can also use these overrides to configure the [Terraform provider for Boundary](https://github.com/hashicorp/terraform-provider-boundary): +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 = "foo" - auth_method_password = "foofoofoo" + 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. +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. ## User Interface If you want to develop the Admin UI locally: -The UI is normally compiled into the Boundary binary at build time. -However, it would be impractical to rebuild the binary on every change when -actively developing the UI. To make UI development more convenient, the binary -supports a _passthrough directory_. This is an arbitrary local -directory from which UI assets are served. Note this option is only available -in dev mode. For example: +The UI is normally compiled into the Boundary binary at build time. However, it +would be impractical to rebuild the binary on every change when actively +developing the UI. To make UI development more convenient, the binary supports a +_passthrough directory_. This is an arbitrary local directory from which UI +assets are served. Note this option is only available in dev mode. For example: ```bash BOUNDARY_DEV_PASSTHROUGH_DIRECTORY=../boundary-ui/ui/core/dist ./boundary dev