1
1
# Reception
2
2
3
3
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 _ .
5
5
6
6
![ screenshot] ( https://user-images.githubusercontent.com/804532/30865946-41f08066-a2d8-11e7-86d1-fbe28a418c71.png )
7
7
8
8
## About
9
9
10
10
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_ '.
12
12
In order to be able to resolve '_ anything_ .docker' to * localhost* , this tool also ships a tiny tiny DNS server.
13
13
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* ' ,
15
15
and the traffic will automatically be forwarded to the corresponding port,
16
16
even as you fire up and shut down new _ docker-compose_ projects.
17
17
18
18
## Installation
19
19
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 .
21
21
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 .
23
23
24
24
### Linux
25
25
26
- Fetch and build reception:
26
+ Fetch and build * reception* :
27
27
28
28
go get github.com/ninech/reception
29
29
@@ -44,6 +44,7 @@ Try to go to http://reception.docker.
44
44
45
45
Install * reception* using [ homebrew] ( https://brew.sh/ ) :
46
46
47
+ brew tab ninech/homebrew-reception
47
48
brew install ninech/reception/reception
48
49
49
50
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
79
80
Defines on which address and port the HTTP daemon listens. (default "localhost:80")
80
81
-tld string
81
82
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.
82
86
83
87
## Tips & Tricks
84
88
@@ -98,7 +102,7 @@ The container should either have a docker-compose label of `reception.main` or s
98
102
99
103
### Ports
100
104
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
102
106
unnecessary ports either. _ docker-compose_ will bind your exported port to any available local port,
103
107
and _ reception_ will make sure, that there's a url for it.
104
108
@@ -127,15 +131,15 @@ avoid port collisions across projects.
127
131
volume:
128
132
- ./php:/usr/share/nginx/html
129
133
ports:
130
- - 80:80 <----- and _not_ like this
134
+ - 80:80 <----- and _not_ like this (local port)
131
135
pgsql:
132
136
image: postgresql
133
137
ports:
134
- - 5432:5432 <----- and _not_ like this
138
+ - 5432:5432 <----- and _not_ like this (unnecessary port)
135
139
136
140
### HTTP Port
137
141
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
139
143
80, 8080 and 3000. You can override this behaviour by setting the label ` reception.http-port ` to a port of your choice:
140
144
141
145
version: '2'
@@ -151,7 +155,7 @@ In order to detect which port "the http port" of you container is, _reception_ l
151
155
152
156
### Reception can't bind to the ports
153
157
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).
155
159
156
160
### _ docker-compose_ projects can't start because of port conflicts
157
161
@@ -169,7 +173,7 @@ In the case above, you would just replace `"80:80"` with `80`.
169
173
170
174
### Is the DNS cache outdated?
171
175
172
- ** Note:** _ reception _ must be running at this stage already!
176
+ ** Note:** * reception * must be running at this stage already!
173
177
174
178
` nslookup foobar.docker ` should resolve to ` 127.0.0.1 ` or ` ::1 ` .
175
179
0 commit comments