diff --git a/README.md b/README.md index ab628a0..c394684 100644 --- a/README.md +++ b/README.md @@ -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) @@ -10,20 +10,27 @@ cd nginx-rtmp-geoip2-alpine chmod +x docker-entrypoint.sh envsubst-on-templates.sh tune-worker-processes.sh docker build . -t your_image_tag ``` + ## Run the image + ```sh 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' 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 -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 /usr/share/geoip/ ``` + In a docker-compose file that would look like: + ```sh webserver: image: admintuts/nginx:1.21.5-rtmp-geoip2-alpine @@ -38,7 +45,9 @@ In a docker-compose file that would look like: networks: - default ``` + ## Running With Kubernetes Statefulset + ```yaml apiVersion: apps/v1 kind: StatefulSet @@ -91,6 +100,7 @@ spec: # persistentVolumeClaim: # claimName: nginx-pvc ``` + ## License MIT