From e09b4270814721cff824b9e4566b8486c9e9161c Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Fri, 7 Feb 2020 16:07:26 +1000 Subject: [PATCH] Updated documentation --- README.md | 4 +-- doc/ADVANCED_NGINX.md | 2 +- doc/DOCKERHUB.md | 52 --------------------------------------- doc/IMPORTING.md | 57 ------------------------------------------- doc/INSTALL.md | 11 ++++++--- 5 files changed, 10 insertions(+), 116 deletions(-) delete mode 100644 doc/DOCKERHUB.md delete mode 100644 doc/IMPORTING.md diff --git a/README.md b/README.md index d60f127d..17929508 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,8 @@ I won't go in to too much detail here but here are the basics for someone new to 1. Your home router will have a Port Forwarding section somewhere. Log in and find it 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 +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) +4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services ## Nginx Proxy Manager in the wild diff --git a/doc/ADVANCED_NGINX.md b/doc/ADVANCED_NGINX.md index eabac84c..37d941ea 100644 --- a/doc/ADVANCED_NGINX.md +++ b/doc/ADVANCED_NGINX.md @@ -14,4 +14,4 @@ You can add your custom configuration snippet files at `/data/nginx/custom` as f `/data/nginx/custom/server_stream_tcp.conf`: Included at the end of every TCP stream server block `/data/nginx/custom/server_stream_udp.conf`: Included at the end of every UDP stream server block -Every file is optional. \ No newline at end of file +Every file is optional. diff --git a/doc/DOCKERHUB.md b/doc/DOCKERHUB.md deleted file mode 100644 index 1aa1b439..00000000 --- a/doc/DOCKERHUB.md +++ /dev/null @@ -1,52 +0,0 @@ -![Nginx Proxy Manager](https://public.jc21.com/nginx-proxy-manager/github.png "Nginx Proxy Manager") - -# [Nginx Proxy Manager](https://nginxproxymanager.jc21.com) - -![Version](https://img.shields.io/badge/version-2.0.14-green.svg?style=for-the-badge) -![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) - -[View on Github](https://github.com/jc21/nginx-proxy-manager) - -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. - - -## Tags - -* latest 2, 2.x.x ([Dockerfile](https://github.com/jc21/nginx-proxy-manager/blob/master/Dockerfile)) -* latest-arm64, 2-arm64, 2.x.x-arm64 ([Dockerfile](https://github.com/jc21/nginx-proxy-manager/blob/master/Dockerfile.arm64)) -* latest-arm7l, 2-arm7l, 2.x.x-arm7l ([Dockerfile](https://github.com/jc21/nginx-proxy-manager/blob/master/Dockerfile.arm7l)) - - -## Getting started - -Please consult the [installation instructions](https://github.com/jc21/nginx-proxy-manager/blob/master/doc/INSTALL.md) for a complete guide or -if you just want to get up and running in the quickest time possible, grab all the files in the [doc/example/](https://github.com/jc21/nginx-proxy-manager/tree/master/doc/example) folder and run: - -```bash -docker-compose up -d -``` - - -## Screenshots - -[![Login](https://public.jc21.com/nginx-proxy-manager/v2/small/login.jpg "Login")](https://public.jc21.com/nginx-proxy-manager/v2/large/login.jpg) -[![Dashboard](https://public.jc21.com/nginx-proxy-manager/v2/small/dashboard.jpg "Dashboard")](https://public.jc21.com/nginx-proxy-manager/v2/large/dashboard.jpg) -[![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) -[![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) -[![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) -[![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) -[![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) -[![Streams](https://public.jc21.com/nginx-proxy-manager/v2/small/streams.jpg "Streams")](https://public.jc21.com/nginx-proxy-manager/v2/large/streams.jpg) -[![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) -[![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) -[![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) -[![Certificates](https://public.jc21.com/nginx-proxy-manager/v2/small/certificates.jpg "Certificates")](https://public.jc21.com/nginx-proxy-manager/v2/large/certificates.jpg) -[![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) -[![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) -[![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) -[![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) -[![Users](https://public.jc21.com/nginx-proxy-manager/v2/small/users.jpg "Users")](https://public.jc21.com/nginx-proxy-manager/v2/large/users.jpg) -[![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) -[![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) diff --git a/doc/IMPORTING.md b/doc/IMPORTING.md deleted file mode 100644 index bfda5164..00000000 --- a/doc/IMPORTING.md +++ /dev/null @@ -1,57 +0,0 @@ -## Importing from Version 1 - -Thanks for using Nginx Proxy Manager version 1. It sucked. - -But it worked. - -This guide will let your import your configuration from version 1 to version 2. - -**IMPORTANT: This will make changes to your `letsencrypt` folder and certificate files!** Make sure you back them up first. - - -### Link your previous folders in your new docker stack - -In version 1, the docker configuration asked for a `config` folder to be linked and a `letsencrypt` folder. However in version 2, the -configuration exists in the database, so the `config` folder is no longer required. However if you have this folder linked in a -version 2 stack, the application will automatically import that configuration the first time it finds it. - -Following the [example configuration](../example): - -```yaml -version: "3" -services: - app: - image: jc21/nginx-proxy-manager:2 - restart: always - ports: - - 80:80 - - 81:81 - - 443:443 - volumes: - - ./config.json:/app/config/production.json - - ./data:/data - - ./letsencrypt:/etc/letsencrypt # this is your previous letsencrypt folder - - ./config:/config # this is your previous config folder - depends_on: - - db - db: - image: mariadb - restart: always - environment: - MYSQL_ROOT_PASSWORD: "password123" - MYSQL_DATABASE: "nginxproxymanager" - MYSQL_USER: "nginxproxymanager" - MYSQL_PASSWORD: "password123" - volumes: - - ./data/mysql:/var/lib/mysql -``` - -After you start the stack, the import will begin just after database initialize. - -Some notes: -- After importing, a file is created in the `config` folder to signify that it has been imported and should not be imported again. -- Because no users previously existed in the version 1 config, the `admin@example.com` user will own all of the imported data. -- If you were crazy like me and used Nginx Proxy Manager version 1 to proxy the Admin interface behind a Access List, you should -really disable the access list for that proxy host in version 1 before importing in to version 2. The app doesn't like being behind basic -authentication and it's own internal authentication. If you forgot to do this before importing, just hit the admin interface directly -on port 81 to get around your basic authentication access list. diff --git a/doc/INSTALL.md b/doc/INSTALL.md index ad74c08d..f86a1784 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -57,7 +57,7 @@ Via `docker-compose`: version: "3" services: app: - image: jc21/nginx-proxy-manager:latest + image: jc21/nginx-proxy-manager:2 restart: always ports: # Public HTTP Port: @@ -74,7 +74,7 @@ services: depends_on: - db db: - image: mariadb + image: mariadb:latest restart: always environment: MYSQL_ROOT_PASSWORD: "npm" @@ -94,9 +94,12 @@ docker-compose up -d ### Running on Raspberry PI / ARM devices -There are docker images for all versions of the Rasberry Pi with the exception of the really old `armv6l` versions. +The docker images support the following architectures: +- amd64 +- arm64 +- armv7 -The `latest` docker image is a manifest of all the different architecture docker builds supported, so this means +The docker images are a manifest of all the architecture docker builds supported, so this means you don't have to worry about doing anything special and you can follow the common instructions above. Check out the [dockerhub tags](https://cloud.docker.com/repository/registry-1.docker.io/jc21/nginx-proxy-manager/tags)