linuxserver/nginx ¶

Nginx is a simple webserver with php support. The config files reside in /config for easy user customization.

Supported Architectures¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/nginx:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup¶

Add your web files to /config/www for hosting. Modify the nginx, php and site config files under /config as needed

Read-Only Operation¶

This image can be run with a read-only container filesystem. For details please read the docs.

Caveats¶

/tmp must be mounted to tmpfs

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)¶

---
services:
  nginx:
    image: lscr.io/linuxserver/nginx:latest
    container_name: nginx
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/nginx/config:/config
    ports:
      - 80:80
      - 443:443
    restart: unless-stopped

docker cli (click here for more info)¶

docker run -d \
  --name=nginx \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/nginx/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/nginx:latest

Parameters¶

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (`-p`)¶

Parameter	Function
`80:80`	http
`443:443`	https

Environment Variables (`-e`)¶

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.

Volume Mappings (`-v`)¶

Volume	Function
`/config`	Persistent config files

Miscellaneous Options¶

Parameter	Function
`--read-only=true`	Run container with a read-only filesystem. Please read the docs.

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers¶

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info¶

Shell access whilst the container is running:
```
docker exec -it nginx /bin/bash
```
To monitor the logs of the container in realtime:
```
docker logs -f nginx
```

Container version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' nginx

Image version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nginx:latest

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull nginx
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d nginx
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/nginx:latest

Stop the running container:
```
docker stop nginx
```
Delete the container:
```
docker rm nginx
```
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
```
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-nginx.git
cd docker-nginx
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/nginx:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

To help with development, we generate this dependency graph.

Init dependency graph

Versions¶

17.12.24: - Rebase to Alpine 3.21.
31.05.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
05.03.24: - Rebase to Alpine 3.19 with php 8.3.
25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
16.01.23: - Remove nchan module because it keeps causing crashes.
22.12.22: - Rebase to Alpine 3.17 with PHP 8.1, migrate to s6v3.
20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
22.05.22: - Install nginx version from 3.14.
01.07.21: - Rebasing to alpine 3.14.
24.06.21: - Update default nginx conf folder.
12.04.21: - Add php7-gmp and php7-pecl-mailparse.
13.02.21: - Remove php7-pecl-imagick (it now installs the full imagemagick with too much crud). Users can install it via this docker mod.
09.02.21: - Rebasing to alpine 3.13. Add nginx mods brotli and dav-ext. Remove nginx mods lua and lua-upstream (due to regression over the last couple of years).
08.09.20: - Add php7-xsl.
01.06.20: - Rebasing to alpine 3.12.
18.04.20: - Fix unwanted shutdown of the container.
11.03.20: - Add php7-sodium.
18.02.20: - Add geoip2, suppress lua warning.
19.12.19: - Rebasing to alpine 3.11.
18.12.19: - Add php7-imap and php7-pecl-apcu.
13.11.19: - Add php7-pdo_odbc.
24.10.19: - Add php7-pecl-imagick.
06.08.19: - Add php7-bcmath, ph7-pear, php7-xmlrpc and php7-ftp.
02.08.19: - Add php7-ldap.
28.06.19: - Rebasing to alpine 3.10.
08.05.19: - Remove default.conf when nginx is upgraded in downstream image.
30.04.19: - Add php-redis.
23.03.19: - Switching to new Base images, shift to arm32v7 tag.
02.03.19: - Add php intl and posix modules.
28.02.19: - Add php7-opcache, remove memcached service due to issues on aarch64 (let us know if you need to enable it).
22.02.19: - Rebasing to alpine 3.9.
18.11.18: - Attempt to upgrade packages during build.
28.09.18: - Multi-arch image.
17.08.18: - Rebase to alpine 3.8, inherit nginx.conf from nginx baseimage.
11.05.18: - Add php pgsql support.
19.04.18: - Bind memcached to localhost only, add php7-sqlite3.
05.01.18: - Rebase to alpine 3.7.
08.11.17: - Add php7 soap module.
31.10.17: - Add php7 exif and xmlreader modules.
30.09.17: - Copy additional root files into image.
24.09.17: - Add memcached service.
31.08.17: - Add php7-phar.
14.07.17: - Enable modules dynamically in nginx.conf.
22.06.17: - Add various nginx modules and enable all modules in the default nginx.conf.
05.06.17: - Add php7-bz2.
25.05.17: - Rebase to alpine 3.6.
18.04.17: - Add php7-sockets.
27.02.17: - Rebase to alpine 3.5, update to nginx 1.10.2 and php7.
14.10.16: - Add version layer information.
10.09.16: - Add badges to README.
05.12.15: - Intial Release.

linuxserver/nginx¶