diff --git a/website/source/docs/install/ports.html.md b/website/source/docs/install/ports.html.md new file mode 100644 index 0000000000..ac5f6d5960 --- /dev/null +++ b/website/source/docs/install/ports.html.md @@ -0,0 +1,29 @@ +--- +layout: "docs" +page_title: "Required Ports" +sidebar_current: "docs-install-ports" +description: |- + Before starting Consul it is important to have the necessary bind ports accessible. +--- + +# Required Ports + +Before running Consul, you should ensure the following bind ports are accessible. + + +| Use | Default Ports | +| --------------------------------- | ---------------- | +| DNS: The DNS server | 8600 | +| HTTP: The HTTP API | 8500 | +| HTTPS: The HTTPs API | disabled (8501)* | +| gRPC: The gRPC API | disabled (8502)* | +| LAN Serf: The Serf LAN port. | 8301 | +| Wan Serf: The Serf WAN port | 8302 | +| server: Server RPC address | 8300 | +| Sidecar Proxy Min: Inclusive min port number to use for automatically assigned sidecar service registrations. | 21000 | +| Sidecar Proxy Max: Inclusive max port number to use for automatically assigned sidecar service registrations. | 21255 | + +*For `HTTPS` and `gRPC` the ports specified in the table +are recommendations. + +Note, the default ports can be changed in the [agent configuration](/docs/agent/options.html#ports). \ No newline at end of file diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 163accbf12..eb54b0ba9a 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -3,6 +3,11 @@