Skip to content

Commit 097e696

Browse files
authored
Update README.md
1 parent 4f35b7d commit 097e696

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

.github/README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,10 @@ docker network connect myownnetwork nginx-gen
140140
docker network connect myownnetwork nginx-letsencrypt
141141
```
142142

143-
3. Using different ports to be proxied
143+
3. Ports
144144

145-
If your service container runs on port 8545 you probably will need to add the `VIRTUAL_PORT` environment variable to your container, in the `docker-compose.yml`, as of:
145+
If your service container runs on port 8545 you probably will need to add the `VIRTUAL_PORT` environment variable to your container,
146+
in the `docker-compose.yml`, so it can be proxied, as of:
146147

147148
```bash
148149
parity
@@ -170,12 +171,12 @@ docker exec -it ${NGINX_WEB} nginx -s reload
170171
Where *${NGINX_WEB}* is your proxy container name, which in the original `.env` file is set as *nginx-web*.
171172

172173

173-
## Testing your proxy with scripts preconfigured
174+
## Testing nginx-proxy
174175

175176
1. Run the script `test.sh` informing your domain already configured in your DNS to point out to your server as follow:
176177

177178
```bash
178-
./test_start_ssl.sh your.domain.com
179+
./test.sh your.domain.com
179180
```
180181

181182
or simply run:
@@ -184,12 +185,14 @@ or simply run:
184185
docker run -dit -e VIRTUAL_HOST=your.domain.com --network=webproxy --name test-web httpd:alpine
185186
```
186187

188+
> If you want to test the Let's Encrypt certificate as well use `ssl_test.sh your.domain.com`
189+
187190
Access your browser with your domain!
188191

189-
To stop and remove your test container run our `stop_test.sh` script:
192+
To stop and remove your test container run our `stop.sh` script:
190193

191194
```bash
192-
./test_stop.sh
195+
./stop.sh
193196
```
194197

195198
Or simply run:
@@ -198,10 +201,6 @@ Or simply run:
198201
docker stop test-web && docker rm test-web
199202
```
200203

201-
## Running this Proxy on a Synology NAS
202-
203-
Please checkout this [howto](https://github.com/evertramos/nginx-proxy-automation/blob/master/docs/HOWTO-Synlogy.md).
204-
205204
## Other projects using nginx-proxy
206205

207206
Following are links to docker containers using this web proxy:
@@ -213,20 +212,24 @@ Following are links to docker containers using this web proxy:
213212
5. [gitlab-docker-letsencrypt](https://github.com/steevepay/gitlab-docker-letsencrypt)
214213
6. [docker-webtrees-letsencrypt](https://github.com/mstroppel/docker-webtrees-letsencrypt)
215214

215+
## Running this Proxy on a Synology NAS
216+
217+
Please checkout this [howto](https://github.com/evertramos/nginx-proxy-automation/blob/master/docs/HOWTO-Synlogy.md).
218+
216219
## Credits
217220

218-
Without the repositories below this webproxy wouldn´t be possible.
221+
Without the project below this proxy wouldn´t be possible:
219222

220223
Credits goes to:
221-
- nginx-proxy [@jwilder](https://github.com/jwilder/nginx-proxy)
222-
- docker-gen [@jwilder](https://github.com/jwilder/docker-gen)
223-
- docker-letsencrypt-nginx-proxy-companion [@JrCs](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion)
224+
- [nginx-proxy](https://github.com/nginx-proxy/nginx-proxy) by [@jwilder](https://github.com/jwilder)
225+
- [docker-gen](https://github.com/jwilder/docker-gen) by [@jwilder](https://github.com/jwilder)
226+
- [docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) by [@JrCs](https://github.com/JrCs)
224227

225-
### Just in case you are willing to support this project, you will find us at:
228+
## Just in case you are willing to support this project, you will find us at:
226229

227230
- [Patreon (evertramos)](https://www.patreon.com/evertramos)
228231
- [Open Collective (nginx-proxy-automation)](https://opencollective.com/nginx-proxy-automation)
229232

230-
### List of all contributer, supporters, sponsors and backers
233+
## List of all contributers, supporters, sponsors and backers
231234

232235
Please access the page [Supporters, Sponsors and Backers](/.github/sponsor.md).

0 commit comments

Comments
 (0)