From ef34f019144774f40766a6dd60a5772b7ac43239 Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Mon, 9 Jan 2023 21:36:48 +1000 Subject: [PATCH] Update readmes, change docker tag to v3 --- DEV-README.md | 2 +- Jenkinsfile | 7 ++++--- README.md | 26 ++++++++++++++++---------- 3 files changed, 21 insertions(+), 14 deletions(-) diff --git a/DEV-README.md b/DEV-README.md index df593536..ddba0f03 100644 --- a/DEV-README.md +++ b/DEV-README.md @@ -54,7 +54,7 @@ Then choose one or both of the following CA's to set up. - ✅ HTTP Validation - ✅ DNS Validation -\ + Create a Certificate Authority that points to the Step CA: ```bash diff --git a/Jenkinsfile b/Jenkinsfile index 421817eb..a3ad359c 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -45,7 +45,8 @@ pipeline { steps { script { // Defaults to the Branch name, which is applies to all branches AND pr's - env.BUILDX_PUSH_TAGS = "-t docker.io/${DOCKER_ORG}/${IMAGE}:v3-${BRANCH_LOWER}" + // env.BUILDX_PUSH_TAGS = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}" + env.BUILDX_PUSH_TAGS = "-t docker.io/${DOCKER_ORG}/${IMAGE}:v3" } } } @@ -160,7 +161,7 @@ pipeline { stage('Docs Deploy') { when { allOf { - branch 'master' + branch 'v3' // TOODO: change to master when ready not { equals expected: 'UNSTABLE', actual: currentBuild.result } @@ -200,7 +201,7 @@ pipeline { } steps { script { - def comment = pullRequest.comment("This is an automated message from CI:\n\nDocker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/${DOCKER_ORG}/${IMAGE}) as `${DOCKER_ORG}/${IMAGE}:v3-${BRANCH_LOWER}`\n\n**Note:** ensure you backup your NPM instance before testing this PR image! Especially if this PR contains database changes.") + def comment = pullRequest.comment("This is an automated message from CI:\n\nDocker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/${DOCKER_ORG}/${IMAGE}) as `${DOCKER_ORG}/${IMAGE}:github-${BRANCH_LOWER}`\n\n**Note:** ensure you backup your NPM instance before testing this PR image! Especially if this PR contains database changes.") } } } diff --git a/README.md b/README.md index c011d8fb..a66ba16f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,13 @@



- + - - Gitter - - - Reddit -

This project comes as a pre-built docker image that enables you to easily forward to your websites @@ -66,7 +60,7 @@ I won't go in to too much detail here but here are the basics for someone new to version: '3' services: app: - image: 'jc21/nginx-proxy-manager:v3-develop' + image: 'jc21/nginx-proxy-manager:v3' restart: unless-stopped ports: - '80:80' @@ -80,16 +74,28 @@ services: ```bash docker-compose up -d + +# If using docker-compose-plugin +docker compose up -d ``` 4. Log in to the Admin UI When your docker container is running, connect to it on port `81` for the admin interface. -Sometimes this can take a little bit because of the entropy of keys. [http://127.0.0.1:81](http://127.0.0.1:81) +## Contributors + +Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors). + +## Getting Support + +1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues) +2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions) +3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community) +4. [Reddit](https://reddit.com/r/nginxproxymanager) + ## Become a Contributor A guide to setting up your own development environment [is found here](DEV-README.md). -