Skip to content
This repository was archived by the owner on Apr 15, 2020. It is now read-only.

Commit 45e1502

Browse files
authored
✏️ Fixed install instructions
... by adding the `brew tap` part, plus some typos
1 parent 5efc771 commit 45e1502

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Reception
22

33
A dashboard and reverse proxy for your
4-
[**docker-compose**](https://docs.docker.com/compose/) projects. It does not require any dependencies but _Docker_.
4+
[docker-compose](https://docs.docker.com/compose/) projects. It does not require any dependencies but _Docker_ and _docker-compose_.
55

66
![screenshot](https://user-images.githubusercontent.com/804532/30865946-41f08066-a2d8-11e7-86d1-fbe28a418c71.png)
77

88
## About
99

1010
This program shows all _docker-compose_ projects that are running on a handy overview page.
11-
It has a built-in reverse-proxy, so that any container's exposed port are accessible as '_http://container.composeproject.docker_'.
11+
It has a built-in reverse-proxy, so that any container's exposed port are accessible as '_container.compose-project.docker_'.
1212
In order to be able to resolve '_anything_.docker' to *localhost*, this tool also ships a tiny tiny DNS server.
1313

14-
As a result, you'll be able to access your _docker-compose_ projects as *container.compose-project.docker*,
14+
As a result, you'll be able to access your _docker-compose_ projects as '*container.compose-project.docker*',
1515
and the traffic will automatically be forwarded to the corresponding port,
1616
even as you fire up and shut down new _docker-compose_ projects.
1717

1818
## Installation
1919

20-
For resolving `*.docker` to `localhost` (i.e. `127.0.0.1` or `::1`), changes to your local configuration are required.
20+
We assume you have _Docker_ and _docker-compose_ already installed.
2121

22-
Btw, we assume you have _Docker_ and _docker-compose_ already installed.
22+
But for resolving `*.docker` to `localhost` (i.e. `127.0.0.1` or `::1`), changes to your host configuration are required.
2323

2424
### Linux
2525

26-
Fetch and build reception:
26+
Fetch and build *reception*:
2727

2828
go get github.com/ninech/reception
2929

@@ -44,6 +44,7 @@ Try to go to http://reception.docker.
4444

4545
Install *reception* using [homebrew](https://brew.sh/):
4646

47+
brew tab ninech/homebrew-reception
4748
brew install ninech/reception/reception
4849

4950
Next you need to register *reception* as the resolver for the `docker` TLD. Run the
@@ -79,6 +80,9 @@ _reception_ is customizable to some extend. See `reception -h` for a complete li
7980
Defines on which address and port the HTTP daemon listens. (default "localhost:80")
8081
-tld string
8182
Defines on which TLD to react for HTTP and DNS requests. Should end with a "." . (default "docker.")
83+
-v Show version.
84+
-version
85+
Show version.
8286

8387
## Tips & Tricks
8488

@@ -98,7 +102,7 @@ The container should either have a docker-compose label of `reception.main` or s
98102

99103
### Ports
100104

101-
In your `docker-compose.yaml` file, we advice to not specific a local port and to not export any
105+
In your `docker-compose.yaml` file, we advice to not specify a local port and to not export any
102106
unnecessary ports either. _docker-compose_ will bind your exported port to any available local port,
103107
and _reception_ will make sure, that there's a url for it.
104108

@@ -127,15 +131,15 @@ avoid port collisions across projects.
127131
volume:
128132
- ./php:/usr/share/nginx/html
129133
ports:
130-
- 80:80 <----- and _not_ like this
134+
- 80:80 <----- and _not_ like this (local port)
131135
pgsql:
132136
image: postgresql
133137
ports:
134-
- 5432:5432 <----- and _not_ like this
138+
- 5432:5432 <----- and _not_ like this (unnecessary port)
135139

136140
### HTTP Port
137141

138-
In order to detect which port "the http port" of you container is, _reception_ looks for the well-known ports
142+
In order to detect which port "the http port" of you container is, *reception* looks for the well-known ports
139143
80, 8080 and 3000. You can override this behaviour by setting the label `reception.http-port` to a port of your choice:
140144

141145
version: '2'
@@ -151,7 +155,7 @@ In order to detect which port "the http port" of you container is, _reception_ l
151155

152156
### Reception can't bind to the ports
153157

154-
You must run reception as privileged user (i.e. `root`) for it to be able to bind to port 53 (dns) and port 80 (http).
158+
You must run *reception* as privileged user (i.e. `root`) for it to be able to bind to port 53 (dns) and port 80 (http).
155159

156160
### _docker-compose_ projects can't start because of port conflicts
157161

@@ -169,7 +173,7 @@ In the case above, you would just replace `"80:80"` with `80`.
169173

170174
### Is the DNS cache outdated?
171175

172-
**Note:** _reception_ must be running at this stage already!
176+
**Note:** *reception* must be running at this stage already!
173177

174178
`nslookup foobar.docker` should resolve to `127.0.0.1` or `::1`.
175179

0 commit comments

Comments
 (0)