Updated README

This commit is contained in:
Nikolas S
2022-01-01 20:49:04 +02:00
parent 1eb546572b
commit a1e1a63f75

View File

@@ -1,4 +1,4 @@
# NGINX with TLSv1.3 support & built-in RTMP Media Streaming Server with GeoIP2 country database. # NGINX with TLSv1.3 support & built-in RTMP Media Streaming Server with GeoIP2 country database
[![Build Status](https://www.travis-ci.com/sceptic30/nginx-rtmp-geoip2-alpine.svg?branch=master)](https://www.travis-ci.com/sceptic30/nginx-rtmp-geoip2-alpine) ![Docker Pulls](https://img.shields.io/docker/pulls/admintuts/nginx) ![Nginx Version](https://img.shields.io/badge/Nginx-1.21.5-brightgreen) [![Build Status](https://www.travis-ci.com/sceptic30/nginx-rtmp-geoip2-alpine.svg?branch=master)](https://www.travis-ci.com/sceptic30/nginx-rtmp-geoip2-alpine) ![Docker Pulls](https://img.shields.io/docker/pulls/admintuts/nginx) ![Nginx Version](https://img.shields.io/badge/Nginx-1.21.5-brightgreen)
@@ -10,20 +10,27 @@ cd nginx-rtmp-geoip2-alpine
chmod +x docker-entrypoint.sh envsubst-on-templates.sh tune-worker-processes.sh chmod +x docker-entrypoint.sh envsubst-on-templates.sh tune-worker-processes.sh
docker build . -t your_image_tag docker build . -t your_image_tag
``` ```
## Run the image ## Run the image
```sh ```sh
docker run -d --rm --name webserver -p 80:3080 -p 443:3443 your_image_tag docker run -d --rm --name webserver -p 80:3080 -p 443:3443 your_image_tag
``` ```
> Current Image running in non-priviledged mode, under the user 'nginx' > Current Image running in non-priviledged mode, under the user 'nginx'
For more details please visit [Admintuts.net](https://admintuts.net/server-admin/docker/custom-nginx-docker-image-geoip2-rtmp-support/#final-nginx-dockerfile-with-geoip2-rtmp-tlsv1-3-support) For more details please visit [Admintuts.net](https://admintuts.net/server-admin/docker/custom-nginx-docker-image-geoip2-rtmp-support/#final-nginx-dockerfile-with-geoip2-rtmp-tlsv1-3-support)
## How to enable GeoIP2 database ## How to enable GeoIP2 database
You must bind mount your database file (GeoLite2-Country.mmdb or GeoLite2-City.mmdb) to the container file system appropriate location. This location is
You must bind mount your database file (GeoLite2-Country.mmdb or GeoLite2-City.mmdb) to the container file system appropriate location. This location is:
```bash ```bash
/usr/share/geoip/ /usr/share/geoip/
``` ```
In a docker-compose file that would look like: In a docker-compose file that would look like:
```sh ```sh
webserver: webserver:
image: admintuts/nginx:1.21.5-rtmp-geoip2-alpine image: admintuts/nginx:1.21.5-rtmp-geoip2-alpine
@@ -38,7 +45,9 @@ In a docker-compose file that would look like:
networks: networks:
- default - default
``` ```
## Running With Kubernetes Statefulset ## Running With Kubernetes Statefulset
```yaml ```yaml
apiVersion: apps/v1 apiVersion: apps/v1
kind: StatefulSet kind: StatefulSet
@@ -91,6 +100,7 @@ spec:
# persistentVolumeClaim: # persistentVolumeClaim:
# claimName: nginx-pvc # claimName: nginx-pvc
``` ```
## License ## License
MIT MIT