ad5ad69d54
* Add 'Commands (CLI)' docs * Update index.mdx Added Environment variables section * Add 'connect' sub-folder structure * Adding listen address and port environment variables * add connect to the docs navigation * docs: Add Florin's update to index * docs: Fix links and typo * Add front-matter to resolve the PR check issue * Update postgres.mdx Boundary helper for POSTGRES * Completed 'boundary accounts' command docs * Draft connection option documentatino for kube, http, and rdp (#3455) * Style updates for consistency * Clean up using partials * Add 'ssh' doc & updated style for consistency * Fix paste error * Fix the format issue on 'connect ssh' doc * Add 'auth-methods' command doc (#3520) * Add the docs for 'logout', 'server', and 'dev' commands (#3524) * Add the docs for 'logout', 'server', and 'dev' commands * Update the front matter * Add auth-tokens and authenticate command docs (#3575) * Add config command docs (#3576) * updates to the ssh helper command docs (#3523) * updates to the ssh helper command docs * docs: Fix code block * docs: Add minor copy edits --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * docs: Add worker commands * docs: Update workers subcommands (#3598) * docs: Update worker subcommands * docs: Update certificate-authority subcommand * doc: Fix syntax for code refererences * docs: Add `users` commands (#3599) * docs: Add `users` commands * docs: Add more subcommands * docs: Add `target` commands (#3608) * Add command docs for 'credential-libraries' (#3610) * Add 'credential-stores' command docs (#3611) * Add 'credential-stores' command docs * Add the output message * Fix a typo * Fix a typo * Update the dummy token value * docs: Add `storage-bucket` commands - update (#3615) * docs: Add `sessions` commands (#3616) * docs: Add `session-recordings` commands (#3617) * Add 'credentials' command docs (#3619) * Add 'credentials' command docs * Fix typos * docs: Add `scopes` commands (#3620) * docs: Add `scopes` commands * docs: Fix typos * docs: Add `roles` commands (#3621) * docs: Add `roles` commands * docs: Add remaining subcommands * Add 'database' command docs (#3628) * Add 'database' command docs * Update the format inconsistency * docs: Add `managed-groups` commands (#3626) * docs: Add `managed-groups` commands * docs: Clarify description * docs: Add `hosts` commands (#3629) * docs: Add `host-sets` commands (#3630) * docs: Add `host-sets` commands * docs: Copy edits * docs: Add `host-catalogs` commands (#3632) * Add 'boundary groups' command docs (#3636) --------- Co-authored-by: kevin-loehfelm <37027455+kevin-loehfelm@users.noreply.github.com> Co-authored-by: kevin-loehfelm <kevin.loehfelm@hashicorp.com> Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Florin Cătălin Țiucra-Popa <106736683+FlorinTP@users.noreply.github.com> Co-authored-by: Adam Bouhmad <adbouhmad@gmail.com>
84 lines
2.9 KiB
Plaintext
84 lines
2.9 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: server - Command
|
|
description: |-
|
|
The `server` command starts a server (controller, worker, or both) with a configuration file.
|
|
---
|
|
|
|
# server
|
|
|
|
Command: `boundary server`
|
|
|
|
The `server` command starts a server with a configuration file.
|
|
You can use it to start a controller, worker, or both.
|
|
Refer to the [configuration](/boundary/docs/configuration) page to learn more about configuring Boundary.
|
|
|
|
## Examples
|
|
|
|
The following example starts the worker server by providing the full path to the worker config file, `/home/ubuntu/boundary/downstream-worker.hcl`:
|
|
|
|
```shell-session
|
|
$ boundary server -config="/home/ubuntu/boundary/downstream-worker.hcl"
|
|
```
|
|
|
|
**Example output:**
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
==> Boundary server configuration:
|
|
|
|
Cgo: disabled
|
|
Listener 1: tcp (addr: "0.0.0.0:9202", max_request_duration: "1m30s", purpose: "proxy")
|
|
Log Level: info
|
|
Mlock: supported: true, enabled: false
|
|
Version: Boundary v0.13.0+ent
|
|
Version Sha: d8aaf3500f65fb7d605d27db232457fe3a26bf43
|
|
Worker Auth Current Key Id: harddisk-stunt-serve-shininess-essay-courier-manger-deface
|
|
Worker Auth Registration Request: GzusqckarbczHoLGQ4UA25uSRvw33DNChURoR2CF1BXRUm7frqLSncV64LeYWxQDCstE25Vj6QSBQ1aGh8BUo1dnz899rt3LgktzRGU4vWYcHmvPQKpsSUTJqA42nJxBfpxopKyCvzxZNxgbTSw5BNN9BUsnoy58niY5ui38NhKPKdmKjVDoU4TRVd4Bvti4F2H5C8pBB3qhY6qyeaSRoKjDcEzdTa7S3JicVzbtmfWnfyMLTJ21jRypH2S5haK4RBhFP319mw6DYNhVo7opBkBoW2FaaJbeowGj8b5wFX
|
|
Worker Auth Storage Path: /home/ubuntu/boundary/worker2
|
|
Worker Public Proxy Addr: 44.204.92.85:9202
|
|
|
|
==> Boundary server started! Log data will stream in below:
|
|
...
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary server -config=/etc/boundary/controller.hcl
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
|
|
### Command options
|
|
|
|
- `-config` `(string: "")` - The path to the configuration file.
|
|
If you use HCL formatting, you can specify multiple configuration files.
|
|
|
|
- `-config-kms` `(string: "")` - The path to a configuration file that contains a "kms"
|
|
block marked for `config` purpose.
|
|
The kms block decrypts the main configuration file.
|
|
If you do not set a kms block, Boundary looks for the kms block in the main
|
|
configuration file, which has some drawbacks; see the help output for
|
|
"boundary config encrypt -h" for details.
|
|
|
|
- `-log-format` `(string: "")` - The log format to use, mostly as a fallback for events.
|
|
Supported values are `standard` and `json`.
|
|
|
|
- `-log-level` `(string: "")` - The log verbosity level to use, mostly as a fallback for
|
|
events. The following values are supported, in order of more detail to less.
|
|
|
|
- `trace`
|
|
- `debug`
|
|
- `info`
|
|
- `warn`
|
|
- `err`
|
|
|
|
You can also be specify log verbosity level using the **BOUNDARY_LOG_LEVEL** environment variable. |