Skip to content

Commit ba124bc

Browse files
committed
Add coveragerc, update readme.
1 parent ff28425 commit ba124bc

2 files changed

Lines changed: 40 additions & 7 deletions

File tree

.coveragerc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[run]
2+
branch = True
3+
source =
4+
nginx_proxy
5+
nginx
6+
cloudflare
7+
omit =
8+
tests/*
9+
*/test_*
10+
*/__pycache__/*
11+
*/venv/*
12+
*/site-packages/*
13+
setup.py
14+
*/conftest.py
15+
16+
[report]
17+
exclude_lines =
18+
pragma: no cover
19+
def __repr__
20+
raise AssertionError
21+
raise NotImplementedError
22+
if __name__ == .__main__.:
23+
if TYPE_CHECKING:
24+
@abstractmethod
25+
@abstract
26+
precision = 2
27+
show_missing = True
28+
29+
[html]
30+
directory = htmlcov
31+
32+
[xml]
33+
output = coverage.xml

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ No more writing configuration files. `nginx-proxy` watches for container changes
1717
- **Swarm Ready:** Compatible with Docker Swarm services.
1818

1919
## Philosophy
20-
`nginx-proxy` is built on the belief that infrastructure should be invisible. Once deployed you should never have to know that this service is running.
20+
`nginx-proxy` is built on the belief that infrastructure should be invisible. Each service keeps its configuration.
2121

2222
## Quick Start
2323
### 1. Start nginx-proxy
@@ -105,8 +105,8 @@ To expose a container, set the `VIRTUAL_HOST*` environment variable. The contain
105105
| `example.com -> :8080` | Proxies to port 8080. |
106106
| `https://example.com` | HTTPS proxy to container exposed http port |
107107
| `https://example.com/api` | Only /api path is passed on to container. /api prefix is not removed |
108-
| `https://example.com/api -> /v1` | Re-maps path `/api` to `/v1` on contianer exposed port|
109-
| `https://example.com/api -> :8080/v1` | Re-maps path `/api` to `/v1` on contianer port 8080|
108+
| `https://example.com/api -> /v1` | Re-maps path `/api` to `/v1` on container exposed port|
109+
| `https://example.com/api -> :8080/v1` | Re-maps path `/api` to `/v1` on container port 8080|
110110
| `https://example.com/api -> https://_:8080/v1` | Re-maps path `/api` to `/v1` on port 8080. Https is used to connect to container|
111111

112112
**Note:** Directives separated by `;` are injected into the Nginx `location` block.
@@ -119,7 +119,7 @@ WebSocket support requires explicit configuration if the protocol is not detecte
119119
- **Auto-Upgrade:** `VIRTUAL_HOST=https+wss://example.com` (Supports both HTTP and WSS on te host).
120120

121121
### Multiple Hosts
122-
A single container can serve multiple domains path mappings. All that matters is that ev variable starts with `VIRTUAL_HOST` e.g. `VIRTUAL_HOST1`, `VIRTUAL_HOST2`, etc.
122+
A single container can serve multiple domains path mappings. All that matters is that env variable starts with `VIRTUAL_HOST` e.g. `VIRTUAL_HOST1`, `VIRTUAL_HOST2`, etc.
123123

124124
**Example:**
125125
```bash
@@ -134,13 +134,13 @@ Proxy to external hosts, (not in Docker) using `STATIC_VIRTUAL_HOST`. The contai
134134

135135
Format: `STATIC_VIRTUAL_HOST=domain.com->http://192.168.0.1:8080`.
136136

137-
**Note** Beaware that if domain as target, nginx will crash if DNS resolution fails.
137+
**Note** Be aware that if domain as target, nginx will crash if DNS resolution fails.
138138

139139
## Docker Swarm Support [Preview]
140-
Enable warm mode by setting `DOCKER_SWARM` to `enable` (local & swarm) or `strict` (swarm only).
140+
Enable swarm mode by setting `DOCKER_SWARM` to `enable` (local & swarm) or `strict` (swarm only).
141141
If current node is not manager, set `SWARM_DOCKER_HOST=tcp://manager:2375`.
142142

143-
**Warning** : Automatic exposed port detection will not work when swrm support is enabled. You must explicitly set port on the `VIRTUAL_HOST` or set `VIRTUAL_PORT` on the container.
143+
**Warning** : Automatic exposed port detection will not work when swarm support is enabled. You must explicitly set port on the `VIRTUAL_HOST` or set `VIRTUAL_PORT` on the container.
144144

145145
## Advanced Features
146146
### Redirection

0 commit comments

Comments
 (0)