|  | 
| 1 | 1 | <p align="center"> | 
| 2 | 2 | 	<img src="https://nginxproxymanager.com/github.png"> | 
| 3 | 3 | 	<br><br> | 
| 4 |  | -	<img src="https://img.shields.io/badge/version-2.9.2-green.svg?style=for-the-badge"> | 
|  | 4 | +	<img src="https://img.shields.io/badge/version-2.9.3-green.svg?style=for-the-badge"> | 
| 5 | 5 | 	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager"> | 
| 6 | 6 | 		<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge"> | 
| 7 | 7 | 	</a> | 
|  | 
| 19 | 19 | This project comes as a pre-built docker image that enables you to easily forward to your websites | 
| 20 | 20 | running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt. | 
| 21 | 21 | 
 | 
| 22 |  | -- [Quick Setup](https://nginxproxymanager.com#quick-setup) | 
|  | 22 | +- [Quick Setup](#quick-setup) | 
| 23 | 23 | - [Full Setup](https://nginxproxymanager.com/setup/) | 
| 24 | 24 | - [Screenshots](https://nginxproxymanager.com/screenshots/) | 
| 25 | 25 | 
 | 
| @@ -52,6 +52,65 @@ I won't go in to too much detail here but here are the basics for someone new to | 
| 52 | 52 | 3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53](https://github.com/jc21/route53-ddns) | 
| 53 | 53 | 4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services | 
| 54 | 54 | 
 | 
|  | 55 | +## Quick Setup | 
|  | 56 | + | 
|  | 57 | +1. Install Docker and Docker-Compose | 
|  | 58 | + | 
|  | 59 | +- [Docker Install documentation](https://docs.docker.com/install/) | 
|  | 60 | +- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/) | 
|  | 61 | + | 
|  | 62 | +2. Create a docker-compose.yml file similar to this: | 
|  | 63 | + | 
|  | 64 | +```yml | 
|  | 65 | +version: '3' | 
|  | 66 | +services: | 
|  | 67 | +  app: | 
|  | 68 | +    image: 'jc21/nginx-proxy-manager:latest' | 
|  | 69 | +    ports: | 
|  | 70 | +      - '80:80' | 
|  | 71 | +      - '81:81' | 
|  | 72 | +      - '443:443' | 
|  | 73 | +    environment: | 
|  | 74 | +      DB_MYSQL_HOST: "db" | 
|  | 75 | +      DB_MYSQL_PORT: 3306 | 
|  | 76 | +      DB_MYSQL_USER: "npm" | 
|  | 77 | +      DB_MYSQL_PASSWORD: "npm" | 
|  | 78 | +      DB_MYSQL_NAME: "npm" | 
|  | 79 | +    volumes: | 
|  | 80 | +      - ./data:/data | 
|  | 81 | +      - ./letsencrypt:/etc/letsencrypt | 
|  | 82 | +  db: | 
|  | 83 | +    image: 'jc21/mariadb-aria:latest' | 
|  | 84 | +    environment: | 
|  | 85 | +      MYSQL_ROOT_PASSWORD: 'npm' | 
|  | 86 | +      MYSQL_DATABASE: 'npm' | 
|  | 87 | +      MYSQL_USER: 'npm' | 
|  | 88 | +      MYSQL_PASSWORD: 'npm' | 
|  | 89 | +    volumes: | 
|  | 90 | +      - ./data/mysql:/var/lib/mysql | 
|  | 91 | +``` | 
|  | 92 | +
 | 
|  | 93 | +3. Bring up your stack | 
|  | 94 | +
 | 
|  | 95 | +```bash | 
|  | 96 | +docker-compose up -d | 
|  | 97 | +``` | 
|  | 98 | + | 
|  | 99 | +4. Log in to the Admin UI | 
|  | 100 | + | 
|  | 101 | +When your docker container is running, connect to it on port `81` for the admin interface. | 
|  | 102 | +Sometimes this can take a little bit because of the entropy of keys. | 
|  | 103 | + | 
|  | 104 | +[http://127.0.0.1:81](http://127.0.0.1:81) | 
|  | 105 | + | 
|  | 106 | +Default Admin User: | 
|  | 107 | +``` | 
|  | 108 | + | 
|  | 109 | +Password: changeme | 
|  | 110 | +``` | 
|  | 111 | + | 
|  | 112 | +Immediately after logging in with this default user you will be asked to modify your details and change your password. | 
|  | 113 | + | 
| 55 | 114 | 
 | 
| 56 | 115 | ## Contributors | 
| 57 | 116 | 
 | 
| @@ -331,6 +390,24 @@ Special thanks to the following contributors: | 
| 331 | 390 | 				<br /><sub><b>Filippo Baruffaldi</b></sub> | 
| 332 | 391 | 			</a> | 
| 333 | 392 | 		</td> | 
|  | 393 | +		<td align="center"> | 
|  | 394 | +			<a href="https://github.com/bikram990"> | 
|  | 395 | +				<img src="https://avatars.githubusercontent.com/u/6782131?v=4" width="80" alt=""/> | 
|  | 396 | +				<br /><sub><b>Bikramjeet Singh</b></sub> | 
|  | 397 | +			</a> | 
|  | 398 | +		</td> | 
|  | 399 | +		<td align="center"> | 
|  | 400 | +			<a href="https://github.com/razvanstoica89"> | 
|  | 401 | +				<img src="https://avatars.githubusercontent.com/u/28236583?v=4" width="80" alt=""/> | 
|  | 402 | +				<br /><sub><b>Razvan Stoica</b></sub> | 
|  | 403 | +			</a> | 
|  | 404 | +		</td> | 
|  | 405 | +		<td align="center"> | 
|  | 406 | +			<a href="https://github.com/psharma04"> | 
|  | 407 | +				<img src="https://avatars.githubusercontent.com/u/22587474?v=4" width="80" alt=""/> | 
|  | 408 | +				<br /><sub><b>RBXII3</b></sub> | 
|  | 409 | +			</a> | 
|  | 410 | +		</td> | 
| 334 | 411 | 	</tr> | 
| 335 | 412 | </table> | 
| 336 | 413 | <!-- markdownlint-enable --> | 
|  | 
0 commit comments