nginx-proxy-manager/docs
2021-05-08 12:10:48 +10:00
..
.vuepress Added upgrade steps 2021-03-17 08:58:45 +10:00
advanced-config Merge pull request #943 from phantomski77/patch-1 2021-03-16 19:51:03 +10:00
faq Update github templates and docs 2021-02-17 20:18:12 +10:00
guide v2.2.0 New Brand (#319) 2020-03-11 16:54:10 +10:00
screenshots v2.2.0 New Brand (#319) 2020-03-11 16:54:10 +10:00
setup docker-compose Instructions for streams support 2021-03-18 01:20:47 -03:00
third-party Update github templates and docs 2021-02-17 20:18:12 +10:00
upgrading Added upgrade steps 2021-03-17 08:58:45 +10:00
.gitignore v2.2.0 New Brand (#319) 2020-03-11 16:54:10 +10:00
package.json Bump node-forge from 0.9.1 to 0.10.0 in /docs 2020-09-17 23:42:28 +00:00
README.md Added upgrade steps 2021-03-17 08:58:45 +10:00
yarn.lock Merge pull request #1070 from jc21/dependabot/npm_and_yarn/docs/lodash-4.17.21 2021-05-08 12:10:48 +10:00

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'
    environment:
      DB_MYSQL_HOST: "db"
      DB_MYSQL_PORT: 3306
      DB_MYSQL_USER: "npm"
      DB_MYSQL_PASSWORD: "npm"
      DB_MYSQL_NAME: "npm"
    volumes:
      - ./data:/data
      - ./letsencrypt:/etc/letsencrypt
  db:
    image: 'jc21/mariadb-aria:latest'
    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. Sometimes this can take a little bit because of the entropy of keys.

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.

  1. Upgrading to new versions
docker-compose pull
docker-compose up -d

This project will automatically update any databases or other requirements so you don't have to follow any crazy instructions. These steps above will pull the latest updates and recreate the docker containers.