docs/docker-trusted-registry/reference/install.md

58 lines
8.9 KiB
Markdown

---
description: Docker Trusted Registry install command reference.
keywords:
- docker, registry, reference, install
menu:
main:
identifier: dtr_reference_install
parent: dtr_menu_reference
title: install
---
# docker/dtr install
Install Docker Trusted Registry on this Docker Engine
## Usage
```bash
docker run -it --rm docker/dtr \
install [command options]
```
## Description
This command installs DTR on the Docker Engine that runs the command.
After installing DTR, you can add more nodes to a DTR cluster with
the 'join' command.
## Options
| Option | Description |
|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--ucp-username` | Specify the UCP admin username |
| `--ucp-password` | Specify the UCP admin password |
| `--debug` | Enable debug mode, provides additional logging |
| `--hub-username` | Specify the Docker Hub username for pulling images |
| `--hub-password` | Specify the Docker Hub password for pulling images |
| `--http-proxy` | Set the HTTP proxy for outgoing requests |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests |
| `--no-proxy` | Set the list of domains to not proxy to |
| `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
| `--replica-https-port` | Specify the public HTTPS port for the DTR replica; 0 means unchanged/default |
| `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal |
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp |
| `--log-level` | Log level for container logs. Default: INFO |
| `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--etcd-heartbeat-interval` | Set etcd's frequency (ms) that its leader will notify followers that it is still the leader. |
| `--etcd-election-timeout` | Set etcd's timeout (ms) for how long a follower node will go without hearing a heartbeat before attempting to become leader itself. |
| `--etcd-snapshot-count` | Set etcd's number of changes before creating a snapshot. |
| `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--ucp-node` | Specify the host to install Docker Trusted Registry |
| `--replica-id` | Specify the replica ID. Must be unique per replica, leave blank for random |
| `--unsafe` | Enable this flag to skip safety checks when installing or joining |
| `--extra-envs` | List of extra environment variables to use for deploying the DTR containers for the replica. This can be used to specify swarm constraints. Separate the environment variables with ampersands (&). You can escape actual ampersands with backslashes (\). Can't be used in combination with --ucp-node |