Skip to content

Commit ef34f01

Browse files
committed
Update readmes, change docker tag to v3
1 parent f5b3568 commit ef34f01

File tree

3 files changed

+21
-14
lines changed

3 files changed

+21
-14
lines changed

DEV-README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Then choose one or both of the following CA's to set up.
5454

5555
- ✅ HTTP Validation
5656
- ✅ DNS Validation
57-
\
57+
5858
Create a Certificate Authority that points to the Step CA:
5959

6060
```bash

Jenkinsfile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ pipeline {
4545
steps {
4646
script {
4747
// Defaults to the Branch name, which is applies to all branches AND pr's
48-
env.BUILDX_PUSH_TAGS = "-t docker.io/${DOCKER_ORG}/${IMAGE}:v3-${BRANCH_LOWER}"
48+
// env.BUILDX_PUSH_TAGS = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
49+
env.BUILDX_PUSH_TAGS = "-t docker.io/${DOCKER_ORG}/${IMAGE}:v3"
4950
}
5051
}
5152
}
@@ -160,7 +161,7 @@ pipeline {
160161
stage('Docs Deploy') {
161162
when {
162163
allOf {
163-
branch 'master'
164+
branch 'v3' // TOODO: change to master when ready
164165
not {
165166
equals expected: 'UNSTABLE', actual: currentBuild.result
166167
}
@@ -200,7 +201,7 @@ pipeline {
200201
}
201202
steps {
202203
script {
203-
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.")
204+
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.")
204205
}
205206
}
206207
}

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
<p align="center">
22
<img src="https://nginxproxymanager.com/github.png">
33
<br><br>
4-
<img src="https://img.shields.io/badge/version-3.0.0-green.svg?style=for-the-badge">
4+
<img src="https://img.shields.io/badge/version-2.9.19-green.svg?style=for-the-badge">
55
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
66
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
77
</a>
88
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
99
<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
1010
</a>
11-
<a href="https://gitter.im/nginx-proxy-manager/community">
12-
<img alt="Gitter" src="https://img.shields.io/gitter/room/nginx-proxy-manager/community?style=for-the-badge">
13-
</a>
14-
<a href="https://reddit.com/r/nginxproxymanager">
15-
<img alt="Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/nginxproxymanager?label=Reddit%20Community&style=for-the-badge">
16-
</a>
1711
</p>
1812

1913
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
6660
version: '3'
6761
services:
6862
app:
69-
image: 'jc21/nginx-proxy-manager:v3-develop'
63+
image: 'jc21/nginx-proxy-manager:v3'
7064
restart: unless-stopped
7165
ports:
7266
- '80:80'
@@ -80,16 +74,28 @@ services:
8074
8175
```bash
8276
docker-compose up -d
77+
78+
# If using docker-compose-plugin
79+
docker compose up -d
8380
```
8481

8582
4. Log in to the Admin UI
8683

8784
When your docker container is running, connect to it on port `81` for the admin interface.
88-
Sometimes this can take a little bit because of the entropy of keys.
8985

9086
[http://127.0.0.1:81](http://127.0.0.1:81)
9187

88+
## Contributors
89+
90+
Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
91+
92+
## Getting Support
93+
94+
1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
95+
2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
96+
3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
97+
4. [Reddit](https://reddit.com/r/nginxproxymanager)
98+
9299
## Become a Contributor
93100

94101
A guide to setting up your own development environment [is found here](DEV-README.md).
95-

0 commit comments

Comments
 (0)