Skip to content

Commit

Permalink
Fix minor issues in the docs (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
sethfowler authored Apr 3, 2023
1 parent 4b0e940 commit 54fcb22
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ name `relay:image`; you'll need to substitute in the name of the image you
obtained above. For example, if you built a local Docker image, you'll want to
replace `relay:image` with `relay:local-v0`.

Running Relay requires that you set one required option: the target. This
option tells Relay where to direct the traffic it receives. It's specified
as a URL, but you only need to provide the protocol and host; the path and query
parameters are derived from incoming requests. As a convenience, you can specify
the target by starting the container with the `TRAFFIC_RELAY_TARGET` environment
variable set appropriately:
To run Relay, you must set one required option: the target. This option tells
Relay where to direct the traffic it receives. It's specified as a URL, but you
only need to provide the protocol and host; the path and query parameters are
derived from incoming requests. As a convenience, you can specify the target by
starting the container with the `TRAFFIC_RELAY_TARGET` environment variable set
appropriately:

docker run -e "TRAFFIC_RELAY_TARGET=https://target.example:12346" --publish 8990:8990 -it --rm relay:image

Expand Down Expand Up @@ -97,4 +97,4 @@ using the `--config` option:
./dist/relay --config /etc/relay/relay.yaml

If you plan to add new functionality to Relay, it's important to understand
its plugin-based architecture; you can read more about that [here](plugins.md].
its plugin-based architecture; you can read more about that [here](plugins.md).

0 comments on commit 54fcb22

Please sign in to comment.