From 81b3366a8b8ad022056f24e42c73700060bec5fe Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Wed, 25 Jul 2018 08:40:21 +1000 Subject: [PATCH] Updated readme, push preview to dockerhub --- Jenkinsfile | 15 +++++++++++++++ README.md | 36 ++++++++++++------------------------ 2 files changed, 27 insertions(+), 24 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index d731bba7..d494182e 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -50,6 +50,21 @@ pipeline { } } } + stage('Publish Beta') { + when { + branch 'v2-rewrite' + } + steps { + sh 'docker tag $TEMP_IMAGE_NAME ${DOCKER_PRIVATE_REGISTRY}/$IMAGE_NAME:preview' + sh 'docker push ${DOCKER_PRIVATE_REGISTRY}/$IMAGE_NAME:preview' + sh 'docker tag $TEMP_IMAGE_NAME docker.io/jc21/$IMAGE_NAME:preview' + + withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) { + sh "docker login -u '${duser}' -p '${dpass}'" + sh 'docker push docker.io/jc21/$IMAGE_NAME:preview' + } + } + } } triggers { bitbucketPush() diff --git a/README.md b/README.md index f017d605..6dd5a177 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,15 @@ ![Stars](https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge) ![Pulls](https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge) +**NOTE: Version 2 is a work in progress. Not all of the areas are complete and is definitely not ready for production use.** + This project comes as a pre-built docker image that enables you to easily forward to your websites running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt. ## Features -- Clean and simple interface -- Create an unlimited number of hosts and forward them to any IPv4/Port combination running HTTP -- Secure your sites with SSL and optionally force SSL -- Secure your sites with Basic HTTP Authentication Access Lists -- Advanced Nginx config option for super users -- 3 domain uses: - - Proxy requests to upstream server - - Redirect requests to another domain - - Return immediate 404's - - -## Using [Rancher](https://rancher.com)? - -Easily start an Nginx Proxy Manager Stack by adding [my template catalog](https://github.com/jc21/rancher-templates). +- TBD ## Getting started @@ -38,14 +27,12 @@ By far the easiest way to get up and running. Create this `docker-compose.yml` version: "2" services: app: - image: jc21/nginx-proxy-manager - restart: always + image: jc21/nginx-proxy-manager:preview ports: - 80:80 - 81:81 - 443:443 volumes: - - ./config:/config - ./letsencrypt:/etc/letsencrypt ``` @@ -63,9 +50,7 @@ docker run -d \ -p 80:80 \ -p 81:81 \ -p 443:443 \ - -v /path/to/config:/config \ -v /path/to/letsencrypt:/etc/letsencrypt \ - --restart always \ jc21/nginx-proxy-manager ``` @@ -76,14 +61,19 @@ Now that your docker container is running, connect to it on port `81` for the ad [http://localhost:81](http://localhost:81) -There is no authentication on this interface to keep things simple. It is expected that you would not -expose port 81 to the outside world. - From here, the rest should be self explanatory. Note: Requesting SSL Certificates won't work until this project is accessible from the outside world, as explained below. +### Default Administrator User + +``` +Email: admin@example.com +Password: changeme +``` + + ## Hosting your home network I won't go in to too much detail here but here are the basics for someone new to this self-hosted world. @@ -92,5 +82,3 @@ I won't go in to too much detail here but here are the basics for someone new to 2. Add port forwarding for port 80 and 443 to the server hosting this project 3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS 4. Use the Nginx Proxy Manager here as your gateway to forward to your other web based services - -