Skip to content

Commit 5a65326

Browse files
committed
doc: added README.md
1 parent e2a9b43 commit 5a65326

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Nginx Secure
2+
3+
This repository provides a Dockerized Nginx setup that integrates with Certbot for automatic SSL certificate deployment. It's designed to facilitate secure HTTP and HTTPS traffic forwarding with minimal manual configuration.
4+
5+
## Features
6+
7+
- **Automatic SSL Certificates**: Utilizes Certbot to automatically retrieve and renew SSL certificates from Let's Encrypt.
8+
- **Nginx as a Reverse Proxy**: Configured to act as a reverse proxy, forwarding requests to your application.
9+
- **Dockerized for Ease of Deployment**: Everything runs inside Docker, ensuring consistency across different environments.
10+
11+
## Usage
12+
13+
You can use the pre-built Docker image `nocodb/nginx-secure` as:
14+
15+
```yaml
16+
services:
17+
nginx:
18+
image: nocodb/nginx-secure
19+
ports:
20+
- "80:80"
21+
- "443:443"
22+
volumes:
23+
- ./certs:/etc/letsencrypt/
24+
restart: unless-stopped
25+
env_file: docker.env
26+
27+
application:
28+
image: your-application
29+
restart: unless-stopped
30+
```
31+
32+
Checkout `docker.env.sample` for the required environment variables.
33+
34+
## Building the Image
35+
36+
If you need custom nginx configurations, you can build the image yourself:
37+
38+
1. Clone this repository.
39+
2. Modify the `default.conf.template` file as needed.
40+
3. Run `docker build -t nginx-secure .` in the repository root.

0 commit comments

Comments
 (0)