docs: use $ to denote a command for consistency with other product docs (#468)
This commit is contained in:
1 parent
de700cea87
commit
e37aabac15
3 files changed
+13
-13
No files matched your search
@@ -14,10 +14,10 @@ Building Boundary from source requires:
|
||||
- [Docker](https://docs.docker.com/get-docker/) installed
|
||||
- Basic development environment (git, xcode if you're on Mac, etc)
|
||||
|
||||
1. `git clone https://github.com/hashicorp/boundary` or if you're using SSH auth for
|
||||
github, `git clone git@github.com:hashicorp/boundary`
|
||||
2. `cd boundary`
|
||||
3. `make dev`
|
||||
1. `$ git clone https://github.com/hashicorp/boundary` or if you're using SSH auth for
|
||||
github, `$ git clone git@github.com:hashicorp/boundary`
|
||||
2. `$ cd boundary`
|
||||
3. `$ make dev`
|
||||
|
||||
Once you've built Boundary, the binary will be available at `<repo path>/bin/boundary`. Move this
|
||||
binary to somewhere in your `$PATH` such as `/usr/local/bin`.
|
||||
@@ -25,6 +25,6 @@ binary to somewhere in your `$PATH` such as `/usr/local/bin`.
|
||||
## Cross Platform Build
|
||||
|
||||
If you need to cross compile boundary for another OS or architecture, use the [XC_OSARCH](https://github.com/hashicorp/boundary/blob/master/scripts/build.sh#L26)
|
||||
environment variable to set this. Example: `XC_OSARCH=linux/amd64 make dev`
|
||||
environment variable to set this. Example: `$ XC_OSARCH=linux/amd64 make dev`
|
||||
|
||||
For more details, please consult the [Boundary project on GitHub](https://github.com/hashicorp/boundary#build-and-start-boundary-in-dev-mode).
|
||||
@@ -16,7 +16,7 @@ the target host on the target's default port (`127.0.0.1:22`). Because this
|
||||
target is proxying to our local SSH server, we can use our built-in `connect ssh` command to wrap the proxied TCP connection and SSH via Boundary:
|
||||
|
||||
```
|
||||
boundary connect ssh -target-id ttcp_1234567890
|
||||
$ boundary connect ssh -target-id ttcp_1234567890
|
||||
```
|
||||
|
||||
This will execute SSH on the target and port combination specified by the local
|
||||
@@ -29,7 +29,7 @@ dash will be passed to the executed client. For instance, rather than using
|
||||
`-username`, an equivalent alternative would be:
|
||||
|
||||
```
|
||||
boundary connect ssh -target-id ttcp_1234567890 -- -l some-other-user
|
||||
$ boundary connect ssh -target-id ttcp_1234567890 -- -l some-other-user
|
||||
```
|
||||
|
||||
There is also a `-style` flag to allow the command to format arguments in a
|
||||
@@ -57,7 +57,7 @@ around 'curl', you could update the default TCP target from a default port
|
||||
of `:22` to `:443`:
|
||||
|
||||
```
|
||||
boundary targets update tcp -default-port 443 -id ttcp_1234567890
|
||||
$ boundary targets update tcp -default-port 443 -id ttcp_1234567890
|
||||
|
||||
Target information:
|
||||
Created Time: Fri, 25 Sep 2020 18:35:47 PDT
|
||||
@@ -90,7 +90,7 @@ Now, `curl` can be used as the executed client for the TCP target session to do
|
||||
an authenticated download of hashicorp.com:
|
||||
|
||||
```
|
||||
boundary connect -exec curl -target-id ttcp_1234567890 \
|
||||
$ boundary connect -exec curl -target-id ttcp_1234567890 \
|
||||
-- -vvsL --output /dev/null hashicorp.com
|
||||
|
||||
* Trying 76.76.21.21...
|
||||
@@ -109,5 +109,5 @@ run from WSL, the following allows usage of the wrapper but while specifying the
|
||||
correct available binary, as WSL must use `.exe` when invoking Windows binaries:
|
||||
|
||||
```
|
||||
boundary connect ssh -style putty -exec putty.exe -target-id ttcp_1234567890
|
||||
$ boundary connect ssh -style putty -exec putty.exe -target-id ttcp_1234567890
|
||||
```
|
||||
@@ -11,7 +11,7 @@ description: |-
|
||||
To start Boundary in dev mode:
|
||||
|
||||
```bash
|
||||
boundary dev
|
||||
$ boundary dev
|
||||
```
|
||||
|
||||
## Login to Boundary
|
||||
@@ -23,7 +23,7 @@ dev mode. These can be overridden, or randomly generated, with flags to
|
||||
From the CLI:
|
||||
|
||||
```
|
||||
boundary authenticate password \
|
||||
$ boundary authenticate password \
|
||||
-login-name=admin \
|
||||
-password password \
|
||||
-auth-method-id=ampw_1234567890
|
||||
@@ -39,7 +39,7 @@ You can also use these overrides to configure the [Terraform provider for
|
||||
Boundary](https://github.com/hashicorp/terraform-provider-boundary):
|
||||
|
||||
```hcl
|
||||
provider "boundary" {
|
||||
provider "boundary" {
|
||||
base_url = "http://127.0.0.1:9200"
|
||||
auth_method_id = "ampw_1234567890"
|
||||
auth_method_username = "admin"
|
||||
|
||||
Reference in new issue
Block a user