From 2fe164e9310b6b0403c833f19bd1cee34de58c3b Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 31 Mar 2019 06:33:59 -0400 Subject: [PATCH] Bot Updating Templated Files --- images/docker-nginx.md | 46 ++++++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/images/docker-nginx.md b/images/docker-nginx.md index 870f557c0..feb768f7c 100644 --- a/images/docker-nginx.md +++ b/images/docker-nginx.md @@ -1,30 +1,37 @@ -# linuxserver/nginx +# [linuxserver/nginx](https://github.com/linuxserver/docker-nginx) -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx) [![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nginx.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nginx/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nginx/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](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) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nginx/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nginx/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/index.html) [Nginx](https://nginx.org/) is a simple webserver with php support. The config files reside in `/config` for easy user customization. ## Supported Architectures -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/). +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/). Simply pulling `linuxserver/nginx` 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 | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=nginx \ -e PUID=1000 \ @@ -37,6 +44,7 @@ docker create \ linuxserver/nginx ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -62,38 +70,41 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `80` | http | | `443` | https | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Contains your www content and all relevant configuration files. | + + ## 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`. +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 user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -102,7 +113,9 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Add your web files to `/config/www` for hosting. Modify the nginx, php and site config files under `/config` as needed -_Protip: This container is best combined with a sql server, e.g._ [_mariadb_](https://hub.docker.com/r/linuxserver/mariadb/) +*Protip: This container is best combined with a sql server, e.g. [mariadb](https://hub.docker.com/r/linuxserver/mariadb/)* + + ## Support Info @@ -119,7 +132,7 @@ _Protip: This container is best combined with a sql server, e.g._ [_mariadb_](ht * **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\). +* **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. @@ -141,4 +154,3 @@ _Protip: This container is best combined with a sql server, e.g._ [_mariadb_](ht * **14.10.16:** - Add version layer information. * **10.09.16:** - Add badges to README. * **05.12.15:** - Intial Release. -