trants / npm

Docker container for managing Nginx proxy hosts with a simple, powerful interface.

Nginx Proxy Manager

This repository provides a base on nginx-proxy-manager, 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.

📦 Requirements

The Docker & Docker Compose system requirements are Linux Ubuntu as the OS (other operating systems are supported as well), an absolute minimum 512MB RAM (2GB recommended)

In order to install docker Ubuntu, you will need to meet the following requirements:

• OS: Linux Ubuntu
• Memory: 512MB RAM (2GB Recommended)
• Disk: Sufficient amount to run the Docker containers you wish to use
• CPU: Dependent on the applications you wish to run in the containers

📋 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

🔧 Installation

1. Install Docker and Docker-Compose

• Docker Install documentation
• Docker-Compose Install documentation

2. Bring up your stack by running

git clone https://github.com/trants/npm.git \
    && cd npm \
    && cp .env.example .env

3. Edit environment variable

# NPM
DB_MYSQL_HOST=npm-db
DB_MYSQL_PORT=3306
DB_MYSQL_USER=npm
DB_MYSQL_NAME=npm-production
DB_MYSQL_PASSWORD=npmPassword

# DB
MYSQL_USER=npm
MYSQL_DATABASE=npm-production
MYSQL_PASSWORD=npmPassword
MYSQL_ROOT_PASSWORD=npmRootPassword

# Backup
TZ=UTC
SCHEDULE=@weekly
BACKUP_KEEP_DAYS=7
PASSPHRASE=platonic-subdued-curvy-tweet-backroom
S3_BUCKET=my-s3-bucket
S3_REGION=us-east-1
S3_PREFIX=prefix
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=
MYSQL_HOST=mysql

4. Start NPM

docker-compose up -d

📝 Usage

Reader-friendly documentation can be found here.

📨 Message

I hope you find this useful. If you have any questions, please create an issue.

🔐 Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

📖 License

This software is released under the BSD 3-Clause License. Please see the LICENSE file or https://vspc.vn/license for more information.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Son Tran Thanh 💻 📝

This project follows the all-contributors specification. Contributions of any kind welcome!