Skip to content

Commit 256bd23

Browse files
jc21Jamie Curnow
jc21
and
Jamie Curnow
authored
v2.2.0 New Brand (NginxProxyManager#319)
* Tweaks and backend vscode settings * Version bump * Updated Icon to be more vibrant * New logo and new login screen layout, version bump * New documentation! * Use CI to update package versions because I was sick of changing it everywhere * Generate docs * Docs upload * Fix pipeline * Fix pipeline * Update readme version before generating docs * Testing docs deploy * Fix pipeline * Updated CI link * Fix docs upload * Docs upload fixes * Fix s3 upload grrr * Docs tweaks * Updated readme * Updated screenshots Co-authored-by: Jamie Curnow <jamiec@benon.com>
1 parent 1b6993e commit 256bd23

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+9245
-192
lines changed

‎.version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.1.2
1+
2.2.0

‎Jenkinsfile

+62
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ pipeline {
4242
}
4343
}
4444
}
45+
stage('Versions') {
46+
steps {
47+
sh 'cat frontend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge frontend/package.json'
48+
sh 'echo -e "\\E[1;36mFrontend Version is:\\E[1;33m $(cat frontend/package.json | jq -r .version)\\E[0m"'
49+
sh 'cat backend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge backend/package.json'
50+
sh 'echo -e "\\E[1;36mBackend Version is:\\E[1;33m $(cat backend/package.json | jq -r .version)\\E[0m"'
51+
sh 'sed -i -E "s/(version-)[0-9]+\\.[0-9]+\\.[0-9]+(-green)/\\1${BUILD_VERSION}\\2/" README.md'
52+
}
53+
}
4554
}
4655
}
4756
stage('Frontend') {
@@ -105,6 +114,27 @@ pipeline {
105114
}
106115
}
107116
}
117+
stage('Docs') {
118+
when {
119+
not {
120+
equals expected: 'UNSTABLE', actual: currentBuild.result
121+
}
122+
}
123+
steps {
124+
ansiColor('xterm') {
125+
dir(path: 'docs') {
126+
sh 'yarn install'
127+
sh 'yarn build'
128+
}
129+
130+
dir(path: 'docs/.vuepress/dist') {
131+
sh 'tar -czf ../../docs.tgz *'
132+
}
133+
134+
archiveArtifacts(artifacts: 'docs/docs.tgz', allowEmptyArchive: false)
135+
}
136+
}
137+
}
108138
stage('MultiArch Build') {
109139
when {
110140
not {
@@ -121,6 +151,38 @@ pipeline {
121151
}
122152
}
123153
}
154+
stage('Docs Deploy') {
155+
when {
156+
allOf {
157+
branch 'master'
158+
not {
159+
equals expected: 'UNSTABLE', actual: currentBuild.result
160+
}
161+
}
162+
}
163+
steps {
164+
withCredentials([[$class: 'AmazonWebServicesCredentialsBinding', accessKeyVariable: 'AWS_ACCESS_KEY_ID', credentialsId: 'npm-s3-docs', secretKeyVariable: 'AWS_SECRET_ACCESS_KEY']]) {
165+
sh """docker run --rm \\
166+
--name \${COMPOSE_PROJECT_NAME}-docs-upload \\
167+
-e S3_BUCKET=jc21-npm-site \\
168+
-e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \\
169+
-e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \\
170+
-v \$(pwd):/app \\
171+
-w /app \\
172+
jc21/ci-tools \\
173+
scripts/docs-upload /app/docs/.vuepress/dist/
174+
"""
175+
176+
sh """docker run --rm \\
177+
--name \${COMPOSE_PROJECT_NAME}-docs-invalidate \\
178+
-e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \\
179+
-e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \\
180+
jc21/ci-tools \\
181+
aws cloudfront create-invalidation --distribution-id EYAMDX2I8TPDZ --paths '/*'
182+
"""
183+
}
184+
}
185+
}
124186
stage('PR Comment') {
125187
when {
126188
allOf {

‎README.md

+7-65
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
![Nginx Proxy Manager](https://public.jc21.com/nginx-proxy-manager/github.png "Nginx Proxy Manager")
22

3-
# Nginx Proxy Manager
4-
5-
![Version](https://img.shields.io/badge/version-2.1.2-green.svg?style=for-the-badge)
6-
![Stars](https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge)
7-
![Pulls](https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge)
8-
![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.nginxproxymanager.com%2Fjob%2Fnginx-proxy-manager%2Fjob%2Fmaster&style=for-the-badge)
3+
![Version](https://img.shields.io/badge/version-2.2.0-green.svg?style=for-the-badge)
4+
[![Stars](https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge)](https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager)
5+
[![Pulls](https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge)](https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager)
6+
[![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.nginxproxymanager.com%2Fjob%2Fnginx-proxy-manager%2Fjob%2Fmaster&style=for-the-badge)](https://ci.nginxproxymanager.com/blue/organizations/jenkins/nginx-proxy-manager/branches/)
97

108
This project comes as a pre-built docker image that enables you to easily forward to your websites
119
running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
1210

11+
- [Quick Setup](https://nginxproxymanager.com#quick-setup)
12+
- [Full Setup](https://nginxproxymanager.com/setup/)
13+
- [Screenshots](https://nginxproxymanager.com/screenshots/)
1314

1415
## Project Goal
1516

@@ -31,54 +32,6 @@ so that the barrier for entry here is low.
3132
- User management, permissions and audit log
3233

3334

34-
## Screenshots
35-
36-
[![Login](https://public.jc21.com/nginx-proxy-manager/v2/small/login.jpg "Login")](https://public.jc21.com/nginx-proxy-manager/v2/large/login.jpg)
37-
[![Dashboard](https://public.jc21.com/nginx-proxy-manager/v2/small/dashboard.jpg "Dashboard")](https://public.jc21.com/nginx-proxy-manager/v2/large/dashboard.jpg)
38-
[![Proxy Hosts](https://public.jc21.com/nginx-proxy-manager/v2/small/proxy-hosts.jpg "Proxy Hosts")](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts.jpg)
39-
[![Proxy Host Settings](https://public.jc21.com/nginx-proxy-manager/v2/small/proxy-hosts-new1.jpg "Proxy Host Settings")](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts-new1.jpg)
40-
[![Proxy Host SSL](https://public.jc21.com/nginx-proxy-manager/v2/small/proxy-hosts-new2.jpg "Proxy Host SSL")](https://public.jc21.com/nginx-proxy-manager/v2/large/proxy-hosts-new2.jpg)
41-
[![Redirection Hosts](https://public.jc21.com/nginx-proxy-manager/v2/small/redirection-hosts.jpg "Redirection Hosts")](https://public.jc21.com/nginx-proxy-manager/v2/large/redirection-hosts.jpg)
42-
[![Redirection Host Settings](https://public.jc21.com/nginx-proxy-manager/v2/small/redirection-hosts-new1.jpg "Redirection Host Settings")](https://public.jc21.com/nginx-proxy-manager/v2/large/redirection-hosts-new1.jpg)
43-
[![Streams](https://public.jc21.com/nginx-proxy-manager/v2/small/streams.jpg "Streams")](https://public.jc21.com/nginx-proxy-manager/v2/large/streams.jpg)
44-
[![Stream Settings](https://public.jc21.com/nginx-proxy-manager/v2/small/streams-new1.jpg "Stream Settings")](https://public.jc21.com/nginx-proxy-manager/v2/large/streams-new1.jpg)
45-
[![404 Hosts](https://public.jc21.com/nginx-proxy-manager/v2/small/dead-hosts.jpg "404 Hosts")](https://public.jc21.com/nginx-proxy-manager/v2/large/dead-hosts.jpg)
46-
[![404 Host Settings](https://public.jc21.com/nginx-proxy-manager/v2/small/dead-hosts-new1.jpg "404 Host Settings")](https://public.jc21.com/nginx-proxy-manager/v2/large/dead-hosts-new1.jpg)
47-
[![Certificates](https://public.jc21.com/nginx-proxy-manager/v2/small/certificates.jpg "Certificates")](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates.jpg)
48-
[![Lets Encrypt Certificates](https://public.jc21.com/nginx-proxy-manager/v2/small/certificates-new1.jpg "Lets Encrypt Certificates")](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates-new1.jpg)
49-
[![Custom Certificates](https://public.jc21.com/nginx-proxy-manager/v2/small/certificates-new2.jpg "Custom Certificates")](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates-new2.jpg)
50-
[![Access Lists](https://public.jc21.com/nginx-proxy-manager/v2/small/access-lists.jpg "Access Lists")](https://public.jc21.com/nginx-proxy-manager/v2/large/access-lists.jpg)
51-
[![Access List Users](https://public.jc21.com/nginx-proxy-manager/v2/small/access-lists-new1.jpg "Access List Users")](https://public.jc21.com/nginx-proxy-manager/v2/large/access-lists-new1.jpg)
52-
[![Users](https://public.jc21.com/nginx-proxy-manager/v2/small/users.jpg "Users")](https://public.jc21.com/nginx-proxy-manager/v2/large/users.jpg)
53-
[![User Permissions](https://public.jc21.com/nginx-proxy-manager/v2/small/users-permissions.jpg "User Permissions")](https://public.jc21.com/nginx-proxy-manager/v2/large/users-permissions.jpg)
54-
[![Audit Log](https://public.jc21.com/nginx-proxy-manager/v2/small/audit-log.jpg "Audit Log")](https://public.jc21.com/nginx-proxy-manager/v2/large/audit-log.jpg)
55-
56-
57-
## Getting started
58-
59-
Please consult the [installation instructions](doc/INSTALL.md) for a complete guide or
60-
if you just want to get up and running in the quickest time possible, grab all the files in the `doc/example/` folder and run `docker-compose up -d`
61-
62-
63-
## Administration
64-
65-
When your docker container is running, connect to it on port `81` for the admin interface.
66-
67-
[http://localhost:81](http://localhost:81)
68-
69-
Note: Requesting SSL Certificates won't work until this project is accessible from the outside world, as explained below.
70-
71-
72-
### Default Administrator User
73-
74-
```
75-
Email: admin@example.com
76-
Password: changeme
77-
```
78-
79-
Immediately after logging in with this default user you will be asked to modify your details and change your password.
80-
81-
8235
## Hosting your home network
8336

8437
I won't go in to too much detail here but here are the basics for someone new to this self-hosted world.
@@ -87,14 +40,3 @@ I won't go in to too much detail here but here are the basics for someone new to
8740
2. Add port forwarding for port 80 and 443 to the server hosting this project
8841
3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53](https://github.com/jc21/route53-ddns)
8942
4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
90-
91-
92-
## Nginx Proxy Manager in the wild
93-
94-
As this software gains popularity it's common to see it integrated with other platforms. Please be aware that unless specifically mentioned in the documenation of those
95-
integrations, they are *not supported* by me and any donation links on the pages of those integrations will not come to me even though it looks like it.
96-
97-
Known integrations:
98-
99-
- [HomeAssistant Hass.io plugin](https://github.com/hassio-addons/addon-nginx-proxy-manager)
100-
- [UnRaid / Synology](https://github.com/jlesage/docker-nginx-proxy-manager)

‎backend/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nginx-proxy-manager",
3-
"version": "2.1.2",
3+
"version": "0.0.0",
44
"description": "A beautiful interface for creating Nginx endpoints",
55
"main": "js/index.js",
66
"dependencies": {

‎doc/example/config.json

-10
This file was deleted.

‎doc/example/docker-compose.yml

-28
This file was deleted.

‎docs/.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.vuepress/dist
2+
node_modules
3+
ts

‎docs/.vuepress/config.js

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
module.exports = {
2+
locales: {
3+
"/": {
4+
lang: "en-US",
5+
title: "Nginx Proxy Manager",
6+
description: "Expose your services easily and securely"
7+
}
8+
},
9+
head: [
10+
["link", { rel: "icon", href: "/icon.png" }],
11+
["meta", { name: "description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt" }],
12+
["meta", { property: "og:title", content: "Nginx Proxy Manager" }],
13+
["meta", { property: "og:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
14+
["meta", { property: "og:type", content: "website" }],
15+
["meta", { property: "og:url", content: "https://nginxproxymanager.com/" }],
16+
["meta", { property: "og:image", content: "https://nginxproxymanager.com/icon.png" }],
17+
["meta", { name: "twitter:card", content: "summary"}],
18+
["meta", { name: "twitter:title", content: "Nginx Proxy Manager"}],
19+
["meta", { name: "twitter:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
20+
["meta", { name: "twitter:image", content: "https://nginxproxymanager.com/icon.png"}],
21+
["meta", { name: "twitter:alt", content: "Nginx Proxy Manager"}],
22+
],
23+
themeConfig: {
24+
logo: "/icon.png",
25+
// the GitHub repo path
26+
repo: "jc21/nginx-proxy-manager",
27+
// the label linking to the repo
28+
repoLabel: "GitHub",
29+
// if your docs are not at the root of the repo:
30+
docsDir: "docs",
31+
// defaults to false, set to true to enable
32+
editLinks: true,
33+
locales: {
34+
"/": {
35+
// text for the language dropdown
36+
selectText: "Languages",
37+
// label for this locale in the language dropdown
38+
label: "English",
39+
// Custom text for edit link. Defaults to "Edit this page"
40+
editLinkText: "Edit this page on GitHub",
41+
// Custom navbar values
42+
nav: [{ text: "Setup", link: "/setup/" }],
43+
// Custom sidebar values
44+
sidebar: [
45+
"/",
46+
["/guide/", "Guide"],
47+
["/screenshots/", "Screenshots"],
48+
["/setup/", "Setup Instructions"],
49+
["/advanced-config/", "Advanced Configuration"],
50+
["/third-party/", "Third Party"]
51+
]
52+
}
53+
}
54+
},
55+
plugins: [
56+
[
57+
"@vuepress/google-analytics",
58+
{
59+
ga: "UA-99675467-4"
60+
}
61+
],
62+
[
63+
"sitemap",
64+
{
65+
hostname: "https://nginxproxymanager.com"
66+
}
67+
],
68+
[
69+
'vuepress-plugin-zooming',
70+
{
71+
selector: '.zooming',
72+
delay: 1000,
73+
options: {
74+
bgColor: 'black',
75+
zIndex: 10000,
76+
},
77+
},
78+
],
79+
]
80+
};

‎docs/.vuepress/public/github.png

13.2 KB
Loading

‎docs/.vuepress/public/icon.png

17.6 KB
Loading

‎docs/.vuepress/public/logo.png

56.7 KB
Loading

0 commit comments

Comments
 (0)