From 4148f5a50c254c0eafea512fc10162163f5d00ef Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Wed, 1 Aug 2018 10:21:49 +1000 Subject: [PATCH] More docs --- README.md | 24 +++++++++++++++++++++++- doc/MIGRATING.md | 3 +++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 doc/MIGRATING.md diff --git a/README.md b/README.md index cba99e78..a8f3fefe 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,25 @@ running at home or otherwise, including free SSL, without having to know too muc ## Features -- TBD +- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/) +- Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx +- Free SSL using Let's Encrypt or provide your own custom SSL certificates +- Access Lists and basic HTTP Authentication for your hosts +- Advanced Nginx configuration available for super users +- User management and security + +#### Future Features + +- Live log tail + + +## Screenshots + + +[![Screenshot](https://public.jc21.com/nginx-proxy-manager/npm2-1-sm.jpg "Screenshot")](https://public.jc21.com/nginx-proxy-manager/npm2-1.jpg) +[![Screenshot](https://public.jc21.com/nginx-proxy-manager/npm2-2-sm.jpg "Screenshot")](https://public.jc21.com/nginx-proxy-manager/npm2-2.jpg) +[![Screenshot](https://public.jc21.com/nginx-proxy-manager/npm2-3-sm.jpg "Screenshot")](https://public.jc21.com/nginx-proxy-manager/npm2-3.jpg) +[![Screenshot](https://public.jc21.com/nginx-proxy-manager/npm2-4-sm.jpg "Screenshot")](https://public.jc21.com/nginx-proxy-manager/npm2-4.jpg) ## Getting started @@ -23,6 +41,10 @@ Please consult the [installation instructions](doc/INSTALL.md) for a complete gu 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` +## Migrating from Version 1? + +Here's a [guide for you to migrate your configuration](doc/MIGRATING.md). + ## Administration diff --git a/doc/MIGRATING.md b/doc/MIGRATING.md new file mode 100644 index 00000000..3409ec79 --- /dev/null +++ b/doc/MIGRATING.md @@ -0,0 +1,3 @@ +## Migrating from Version 1 + +TODO