nginx-proxy

Set up a container running nginx and docker-gen with SSL certificates automatically🤖

📃 Usage

1. Clone

To clone and run this application, you'll need Git and Docker Desktop installed on your computer.
From your command line:

# Clone this repository
$ git clone https://github.com/OpenUp-LabTakizawa/nginx-proxy

2. Set variables in the .env file

DEFAULT_EMAIL is used by Let's Encrypt in order to warn you about expiring certificates and allow you to recover your account.
NETWORK is whatever you like.

# For example
- DEFAULT_EMAIL=
- NETWORK=
+ DEFAULT_EMAIL=example@gmail.com
+ NETWORK=nginx_web

3. Docker Compose

# Check if variables are appropriate
$ docker compose convert

# Run and up the containers using docker compose
$ docker compose up -d

# Make sure if there are errors in the containers
$ docker compose logs

🫶 Contribute

Here’s how we suggest you go about proposing a change to this project:

1. Fork this project to your account.
2. Create a branch for the change you intend to make.
3. Make your changes to your fork.
4. Send a pull request from your fork’s branch to our main branch.

Using the web-based interface to make changes is fine too, and will help you by automatically forking the project and prompting to send a pull request too.

📦 Credits

This software uses the following open source packages:

• Docker
• Nginx
• Let's Encrypt
• docker-gen
• nginx-proxy
• acme-companion

⚖️ License

The Apache License Version 2.0 (2023) - OpenUp-LabTakizawa.
Please have a look at the LICENSE for more details.