nginx-proxy-manager/docs/README.md
jc21 256bd2336f
v2.2.0 New Brand (#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>
2020-03-11 16:54:10 +10:00

2.4 KiB
Raw Blame History

home heroImage actionText actionLink footer
true /logo.png Get Started → /guide/ MIT Licensed | Copyright © 2016-present jc21.com

Get Connected

Expose web services on your network · Free SSL with Let's Encrypt · Designed with security in mind · Perfect for home networks

Proxy Hosts

Expose your private network Web services and get connected anywhere.

Beautiful UI

Based on Tabler, the interface is a pleasure to use. Configuring a server has never been so fun.

Free SSL

Built in Lets Encrypt support allows you to secure your Web services at no cost to you. The certificates even renew themselves!

Docker FTW

Built as a Docker Image, Nginx Proxy Manager only requires a database.

Multiple Users

Configure other users to either view or manage their own hosts. Full access permissions are available.

Quick Setup

  1. Install Docker and Docker-Compose
  1. Create a docker-compose.yml file similar to this:
version: '3'
services:
  app:
    image: 'jc21/nginx-proxy-manager:latest'
    ports:
      - '80:80'
      - '81:81'
      - '443:443'
    volumes:
      - ./config.json:/app/config/production.json
      - ./data:/data
      - ./letsencrypt:/etc/letsencrypt
  db:
    image: 'jc21/mariadb-aria:10.4'
    environment:
      MYSQL_ROOT_PASSWORD: 'npm'
      MYSQL_DATABASE: 'npm'
      MYSQL_USER: 'npm'
      MYSQL_PASSWORD: 'npm'
    volumes:
      - ./data/mysql:/var/lib/mysql
  1. Bring up your stack
docker-compose up -d
  1. Log in to the Admin UI

When your docker container is running, connect to it on port 81 for the admin interface.

http://127.0.0.1:81

Default Admin User:

Email:    admin@example.com
Password: changeme

Immediately after logging in with this default user you will be asked to modify your details and change your password.