k44sh/nginx repository overview

⁠About

NGINX⁠ and PHP⁠ Docker image based on Alpine Linux⁠.

⁠Features

• Latest NGINX⁠ with latest PHP 8.3⁠ from Alpine repository
• GeoIP2⁠ database by MaxMind⁠ (Update with your own key)
• s6-overlay⁠ process supervisor
• Run as non-root user
• Multi-platform image

⁠Modules

⁠Example

⁠VTS Module

⁠Supported platforms

• linux/amd64
• linux/arm64
• linux/arm/v7

⁠Usage

⁠Docker Compose

Docker compose is the recommended way to run this image.

Edit the compose file with your preferences and run the following command:

git clone https://github.com/k44sh/nginx.git
mkdir -p {config,data}
docker-compose up -d
docker-compose logs -f

⁠Upgrade

To upgrade, pull the newer image and launch the container:

docker-compose pull
docker-compose up -d

⁠Command line

You can also use the following minimal command:

docker run --rm -d --name nginx \
  -p 80:8080/tcp \
  -p 1935:1935 \
  -e TZ="America/Toronto" \
  k44sh/nginx && \
  docker logs -f nginx

Or this one for more customization:

docker run --rm -d --name nginx \
  --ulimit nproc=65535 \
  --ulimit nofile=32000:40000 \
  --memory=2g \
  --cpus=4 \
  -p 80:8000/tcp \
  -p 1935:1935 \
  -e TZ="America/Toronto" \
  -e PORT="8000" \
  -e PUID="1002" \
  -e PGID="1002" \
  -e USER="docker" \
  -e MM_ACCOUNT="XXXXXX" \
  -e MM_LICENSE="xxxxxxxxxxxx" \
  -e MEMORY_LIMIT="1024M" \
  -e UPLOAD_MAX_SIZE="100M" \
  k44sh/nginx && \
  docker logs -f nginx

⁠Environment Variables

⁠RTMP (Streaming)

• /var/www/stream/play.php: Internal authentication to add an authentication when publishing a stream
• /var/www/stream/publish.php: Internal authentication to add authentication to watch a stream

// Accounts
$accounts  =  array(
  0  =>  array(
    "name"  =>  "user1",
    "pass"  =>  "xxxxxxxxxxxxxxxx"
  ),
[...]

You can configure OBS like this:

• Server Example: rtmp://192.168.1.1/stream
• Key Example: user1?name=user1&key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

You can watch a stream like this:

• Network URL: rtmp://192.168.1.1/stream/user1?name=user1&pass=xxxxxxxxxxxxxxxx

If you want remove authentication, just comment the following directives in nginx.conf:

• on_publish http://127.0.0.1:8080/stream/publish.php⁠;
• on_play http://127.0.0.1:8080/stream/play.php⁠;

Documentation: https://github.com/arut/nginx-rtmp-module/wiki/Directives⁠