Skip to content

Commit

Permalink
doc: added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rohittp0 committed May 3, 2024
1 parent e2a9b43 commit 5a65326
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Nginx Secure

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.

## Features

- **Automatic SSL Certificates**: Utilizes Certbot to automatically retrieve and renew SSL certificates from Let's Encrypt.
- **Nginx as a Reverse Proxy**: Configured to act as a reverse proxy, forwarding requests to your application.
- **Dockerized for Ease of Deployment**: Everything runs inside Docker, ensuring consistency across different environments.

## Usage

You can use the pre-built Docker image `nocodb/nginx-secure` as:

```yaml
services:
nginx:
image: nocodb/nginx-secure
ports:
- "80:80"
- "443:443"
volumes:
- ./certs:/etc/letsencrypt/
restart: unless-stopped
env_file: docker.env

application:
image: your-application
restart: unless-stopped
```
Checkout `docker.env.sample` for the required environment variables.

## Building the Image

If you need custom nginx configurations, you can build the image yourself:

1. Clone this repository.
2. Modify the `default.conf.template` file as needed.
3. Run `docker build -t nginx-secure .` in the repository root.

0 comments on commit 5a65326

Please sign in to comment.