Mirage's Notebook 📖

    Nginx Reverse Proxy

    Install

    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.

    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

    Docker-Compose Install documentation

    1. Create a docker-compose.yml file similar to this:
    version: '3.8'
services:
  app:
    image: 'jc21/nginx-proxy-manager:latest'
    restart: unless-stopped
    ports:
      - '80:80'
      - '81:81'
      - '443:443'
    volumes:
      - ./data:/data
      - ./letsencrypt:/etc/letsencrypt

    This is the bare minimum configuration required. See the documentation

    for more.

    1. Bring up your stack by running
    docker-compose up -d

# If using docker-compose-plugin
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 all of our contributors

    .

    Getting Support

    1. Found a bug?

    Reddit

    Running

    run doc

    Advance config

    advance doc

    Upgrading

    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.

    See the list of releases

    for any upgrade steps specific to each release.

    Third Party

    As this software gains popularity it's common to see it integrated with other platforms. Please be aware that unless specifically mentioned in the documentation of those integrations, they are not supported by me.

    Known integrations:

    ← Free RSS
    Bitwarden →