Go to file
2021-03-21 18:02:53 +02:00
.github/ISSUE_TEMPLATE Update github templates and docs 2021-02-17 20:18:12 +10:00
backend Restrict redirect http code 2021-03-17 14:53:57 +10:00
docker Merge pull request #872 from ahgraber/master 2021-02-08 11:59:23 +10:00
docs Add new details about how to run this image on a Raspberry Pi device. 2021-03-21 18:02:53 +02:00
frontend Merge pull request #769 from jc21/dependabot/npm_and_yarn/frontend/ini-1.3.8 2021-03-17 14:54:45 +10:00
global acmedns indentation fix 2021-03-16 13:36:17 +01:00
scripts Unifies directory structure in dev and prod containers 2020-10-08 13:38:20 +02:00
test Merge pull request #771 from jc21/dependabot/npm_and_yarn/test/ini-1.3.8 2021-01-03 20:14:03 +10:00
.gitignore Use OpenResty base image 2020-05-26 14:38:41 +10:00
.version Forward scheme and http code added for redirection hosts 2021-02-09 11:23:15 +01:00
Jenkinsfile Fix CI, no var needed for this 2021-03-16 11:32:38 +10:00
LICENSE Initial commit 2017-12-21 09:01:17 +10:00
README.md Add new details about how to run this image on a Raspberry Pi device. 2021-03-21 18:02:53 +02:00



Gitter

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.

Project Goal

I created this project to fill a personal need to provide users with a easy way to accomplish reverse proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed. While there might be advanced options they are optional and the project should be as simple as possible so that the barrier for entry here is low.

Buy Me A Coffee

Features

  • Beautiful and Secure Admin Interface based on Tabler
  • 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, permissions and audit log

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.

  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 or Amazon Route53
  4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services

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.

Contributors

Special thanks to the following contributors:


Sebastian Valle

Kyle Klaus

ƬHE ЯAW

Spencer

Xantios Krugor

David Panesso

IronTooch

Damiano

Russ

Marcelo Castagna

Steven Harris

Jocelyn Le Sage

Carl Mercier

Paul Mansfield

OhHeyAlan

Carl Sutton

Gergő Törcsvári

vrenjith

David Rivera

Jaap-Jan de Wit

James Morgan

chaptergy

Philip Mooney

WaterCalm

lebrou34

Mário Franco

Kyle Harding

Alex Graber

MooBaloo

Shuro

Loris Bergeron