Skip to content

Commit a67567b

Browse files
committed
Update README
1 parent 6d5b050 commit a67567b

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,34 @@
11
# Docker Nginx
22

3-
Dockerized Nginx with TLS 1.3 and Brotli support.
3+
Dockerized Nginx based on Alpine Linux with TLS 1.3 and Brotli support.
44

5-
Based on [nginxinc/docker-nginx](https://github.com/nginxinc/docker-nginx).
5+
Inspired by:
6+
- [nginxinc/docker-nginx](https://github.com/nginxinc/docker-nginx)
7+
- [google/ngx_brotli](https://github.com/google/ngx_brotli)
8+
- [fholzer/docker-nginx-brotli](https://github.com/fholzer/docker-nginx-brotli)
69

7-
## Config
10+
## How to use this image
811

9-
To enable TLS 1.3, use:
12+
```shell
13+
docker pull hackinit/nginx-brotli
14+
docker run --name some-nginx -v /some/content:/usr/share/nginx/html:ro -d hackinit/nginx-brotli
15+
```
16+
17+
For extra information, please refer to the [official Docker Hub Nginx documentation](https://hub.docker.com/_/nginx/), since this image builds upon it.
18+
19+
In addition, you can look for Brotli configurations at the official repository [google/ngx_brotli](https://github.com/google/ngx_brotli#configuration-directives).
20+
21+
22+
## Sample config
23+
24+
To enable TLS 1.3, add:
1025

1126
```nginx
1227
ssl_protocols TLSv1.2 TLSv1.3;
1328
ssl_ciphers [TLS13+AESGCM+AES128|TLS13+AESGCM+AES256|TLS13+CHACHA20]:[EECDH+ECDSA+AESGCM+AES128|EECDH+ECDSA+CHACHA20]:EECDH+ECDSA+AESGCM+AES256:EECDH+ECDSA+AES128+SHA:EECDH+ECDSA+AES256+SHA:[EECDH+aRSA+AESGCM+AES128|EECDH+aRSA+CHACHA20]:EECDH+aRSA+AESGCM+AES256:EECDH+aRSA+AES128+SHA:EECDH+aRSA+AES256+SHA:RSA+AES128+SHA:RSA+AES256+SHA:RSA+3DES;
1429
```
15-
To enable Brotli, use this in `http` block:
30+
31+
To enable Brotli, add this in `http` block:
1632

1733
```nginx
1834
brotli on;
@@ -24,14 +40,12 @@ brotli_types *;
2440

2541
## Modification Details
2642

27-
Compiled with OpenSSL 1.1.1b, which supports TLS 1.3.
28-
2943
Module [ngx_brotli](https://github.com/google/ngx_brotli) has been added for Brotli support.
3044

31-
## Build
45+
## Manually build from source
3246

3347
```bash
3448
git clone git://github.com/hackinit/docker-nginx.git
3549
cd docker-nginx
36-
docker build -t nginx:1.15.12-modified .
37-
```
50+
docker build -t nginx-brotli:latest .
51+
```

0 commit comments

Comments
 (0)