diff --git a/Jenkinsfile b/Jenkinsfile index a38c75b..a323772 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -197,6 +197,15 @@ pipeline { else echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} fi + mkdir -p ${TEMPDIR}/gitbook + git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/gitbook/docker-documentation + if [ "${BRANCH_NAME}" = "master" ] && [ ! -f ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md ] || [ "$(md5sum ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" ]; then + cp ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md ${TEMPDIR}/gitbook/docker-documentation/images/ + cd ${TEMPDIR}/gitbook/docker-documentation/ + git add images/docker-${CONTAINER_NAME}.md + git commit -m 'Bot Updating Templated Files' + git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git --all + fi rm -Rf ${TEMPDIR}''' script{ env.FILES_UPDATED = sh( diff --git a/README.md b/README.md index b8fff62..5dd73f8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ TLDR: Multi-arch support is changing from multiple repos to one repo per contain [![](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. @@ -35,6 +37,8 @@ TLDR: Multi-arch support is changing from multiple repos to one repo per contain 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). +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 | @@ -43,6 +47,7 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v6-latest | + ## Usage Here are some example snippets to help you get started creating a container. @@ -113,6 +118,7 @@ In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as bel uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` +   ## Application Setup @@ -131,6 +137,25 @@ Modify the nginx, php and site config files under `/config` as needed * image version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nginx` +## 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 (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. + +Below are the instructions for updating containers: + +### Via Docker Run/Create +* Update the image: `docker pull linuxserver/nginx` +* Stop the running container: `docker stop nginx` +* Delete the container: `docker rm nginx` +* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) +* Start the new container: `docker start nginx` +* You can also remove the old dangling images: `docker image prune` + +### Via Docker Compose +* Update the image: `docker-compose pull linuxserver/nginx` +* Let compose update containers as necessary: `docker-compose up -d` +* You can also remove the old dangling images: `docker image prune` + ## Versions * **18.11.18:** - Attempt to upgrade packages during build.