2021-02-12 13:29:01 +00:00
---
title: nginx
---
2020-07-05 10:33:51 +00:00
# [linuxserver/nginx](https://github.com/linuxserver/docker-nginx)
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-nginx.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-nginx)
[![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-nginx.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github )](https://github.com/linuxserver/docker-nginx/releases)
[![GitHub Package Repository ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github )](https://github.com/linuxserver/docker-nginx/packages)
2020-12-16 14:34:50 +00:00
[![GitLab Container Registry ](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab )](https://gitlab.com/linuxserver.io/docker-nginx/container_registry)
2020-07-05 10:33:51 +00:00
[![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/nginx.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge )](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com")
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/nginx.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker )](https://hub.docker.com/r/linuxserver/nginx)
[![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/nginx.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker )](https://hub.docker.com/r/linuxserver/nginx)
[![Jenkins Build ](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-nginx%2Fjob%2Fmaster%2F&logo=jenkins )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nginx/job/master/)
2020-11-02 03:38:39 +00:00
[![LSIO CI ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fnginx%2Flatest%2Fci-status.yml )](https://ci-tests.linuxserver.io/linuxserver/nginx/latest/index.html)
2019-02-10 11:34:15 +00:00
[Nginx ](https://nginx.org/ ) is a simple webserver with php support. The config files reside in `/config` for easy user customization.
## Supported Architectures
2019-09-01 10:34:27 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-10 11:34:15 +00:00
2020-11-02 03:38:39 +00:00
Simply pulling `ghcr.io/linuxserver/nginx` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-10 11:34:15 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-05 10:33:51 +00:00
| :----: | --- |
2019-02-10 11:34:15 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:31:43 +00:00
| armhf | arm32v7-latest |
2019-02-10 11:34:15 +00:00
2020-07-05 10:33:51 +00:00
2019-02-10 11:34:15 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
2020-10-04 10:34:16 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-10 11:34:15 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-12 10:34:00 +00:00
version: "2.1"
2019-02-10 11:34:15 +00:00
services:
nginx:
2020-11-02 03:38:39 +00:00
image: ghcr.io/linuxserver/nginx
2019-02-10 11:34:15 +00:00
container_name: nginx
environment:
2019-03-03 02:27:50 +00:00
- PUID=1000
- PGID=1000
2019-02-10 11:34:15 +00:00
- TZ=Europe/London
volumes:
- < /path/to/appdata/config>:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
```
2020-10-04 10:34:16 +00:00
### docker cli
```
docker run -d \
--name=nginx \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-p 443:443 \
-v < /path/to/appdata/config>:/config \
--restart unless-stopped \
2020-11-02 03:38:39 +00:00
ghcr.io/linuxserver/nginx
2020-10-04 10:34:16 +00:00
```
2019-02-10 11:34:15 +00:00
## Parameters
2020-07-05 10:33:51 +00:00
Docker images 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.
2019-02-10 11:34:15 +00:00
2020-07-05 10:33:51 +00:00
### Ports (`-p`)
2019-02-10 11:34:15 +00:00
| Parameter | Function |
2020-07-05 10:33:51 +00:00
| :----: | --- |
2019-02-10 11:34:15 +00:00
| `80` | http |
| `443` | https |
2020-07-05 10:33:51 +00:00
### Environment Variables (`-e`)
2019-02-10 11:34:15 +00:00
| Env | Function |
2020-07-05 10:33:51 +00:00
| :----: | --- |
2019-03-03 02:27:50 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-10 11:34:15 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2020-07-05 10:33:51 +00:00
### Volume Mappings (`-v`)
2019-02-10 11:34:15 +00:00
| Volume | Function |
2020-07-05 10:33:51 +00:00
| :----: | --- |
2019-02-10 11:34:15 +00:00
| `/config` | Contains your www content and all relevant configuration files. |
2020-07-05 10:33:51 +00:00
## Environment variables from files (Docker secrets)
2020-05-31 10:34:15 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-07-05 10:33:51 +00:00
```
2020-05-31 10:34:15 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-07-05 10:33:51 +00:00
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 ](https://en.wikipedia.org/wiki/Umask ) before asking for support.
2020-05-03 10:33:56 +00:00
2019-02-10 11:34:15 +00:00
## User / Group Identifiers
2020-07-05 10:33:51 +00:00
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` .
2019-02-10 11:34:15 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 02:27:50 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-10 11:34:15 +00:00
2020-07-05 10:33:51 +00:00
```
2019-02-10 11:34:15 +00:00
$ id username
2019-03-03 02:27:50 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-10 11:34:15 +00:00
```
## Application Setup
Add your web files to `/config/www` for hosting.
Modify the nginx, php and site config files under `/config` as needed
2020-07-05 10:33:51 +00:00
*Protip: This container is best combined with a sql server, e.g. [mariadb ](https://hub.docker.com/r/linuxserver/mariadb/ )*
2019-09-29 10:33:58 +00:00
2020-04-12 10:34:00 +00:00
## Docker Mods
2020-10-04 10:34:16 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=nginx&query=%24.mods%5B%27nginx%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=nginx "view available mods for this container.") [![Docker Universal Mods ](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-12 10:34:00 +00:00
2020-10-04 10:34:16 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/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.
2020-04-12 10:34:00 +00:00
2019-02-10 11:34:15 +00:00
## Support Info
2019-09-01 10:34:27 +00:00
* Shell access whilst the container is running:
2019-02-10 11:34:15 +00:00
* `docker exec -it nginx /bin/bash`
2019-09-01 10:34:27 +00:00
* To monitor the logs of the container in realtime:
2019-02-10 11:34:15 +00:00
* `docker logs -f nginx`
2019-09-01 10:34:27 +00:00
* Container version number
2019-02-10 11:34:15 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' nginx`
* Image version number
2020-11-02 03:38:39 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/nginx`
2019-02-10 11:34:15 +00:00
## Versions
2021-04-12 22:57:39 +00:00
* **12.04.21:** - Add php7-gmp and php7-pecl-mailparse.
2021-02-13 17:40:03 +00:00
* **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 ](https://github.com/linuxserver/docker-mods/tree/swag-imagemagick ).
2021-02-12 14:08:19 +00:00
* **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).
2020-09-17 14:46:11 +00:00
* **08.09.20:** - Add php7-xsl.
2020-06-03 20:28:20 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2020-04-19 02:28:56 +00:00
* **18.04.20:** - Fix unwanted shutdown of the container.
2020-03-12 00:49:47 +00:00
* **11.03.20:** - Add php7-sodium.
2020-02-18 22:43:25 +00:00
* **18.02.20:** - Add geoip2, suppress lua warning.
2019-12-27 11:08:48 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-12-19 05:11:06 +00:00
* **18.12.19:** - Add php7-imap and php7-pecl-apcu.
2020-07-05 10:33:51 +00:00
* **13.11.19:** - Add php7-pdo_odbc.
2019-10-24 17:59:37 +00:00
* **24.10.19:** - Add php7-pecl-imagick.
2019-08-06 21:45:11 +00:00
* **06.08.19:** - Add php7-bcmath, ph7-pear, php7-xmlrpc and php7-ftp.
2019-08-02 20:41:08 +00:00
* **02.08.19:** - Add php7-ldap.
2019-06-30 19:11:12 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-08 17:05:14 +00:00
* **08.05.19:** - Remove default.conf when nginx is upgraded in downstream image.
2019-04-30 18:28:29 +00:00
* **30.04.19:** - Add php-redis.
2019-03-24 19:31:43 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-03 02:27:50 +00:00
* **02.03.19:** - Add php intl and posix modules.
2020-07-05 10:33:51 +00:00
* **28.02.19:** - Add php7-opcache, remove memcached service due to issues on aarch64 (let us know if you need to enable it).
2019-02-24 03:26:11 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-10 11:34:15 +00:00
* **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.