Skip to content

Commit 060311f

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 372069b + 1c994c9 commit 060311f

File tree

3 files changed

+71
-16
lines changed

3 files changed

+71
-16
lines changed

.github/FUNDING.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# These are supported funding model platforms
22

3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
34
patreon: evertramos
5+
open_collective: nginx-proxy-automation
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
13+

.github/README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
11

22
# NGINX Proxy Automation
33

4-
This project automates the [nginx-proxy](https://github.com/nginx-proxy/nginx-proxy).
5-
We strongly recommend you (:pray: please do!) to read all documentation.
6-
7-
> To access the previous version of this project please access [version 0.4](https://github.com/evertramos/nginx-proxy-automation/tree/v0.4).
4+
## What this project does
85

6+
This script will _power up_ your new server with the [*nginx-proxy*](https://github.com/nginx-proxy/nginx-proxy), where you will be able to host multiple sites,
7+
auto renewing Let´s Encrypt certificates! ❤️
98

10-
## Video Tutorial
9+
Something like:
1110

12-
I made a 5 minutes tutorial video:
11+
![Web Proxy environment](https://github.com/evertramos/images/raw/master/webproxy.jpg)
1312

14-
[![NGINX-Proxy-Automation](https://img.youtube.com/vi/E9BtHVr_v9I/0.jpg)](https://www.youtube.com/watch?v=E9BtHVr_v9I)
13+
We strongly recommend you (please do! 🙏) to read all documentation before starting in production as well as the [nginx-proxy docs](https://github.com/nginx-proxy/nginx-proxy).
1514

16-
## What this project does
15+
> To access the previous version of this project please access [version 0.4](https://github.com/evertramos/nginx-proxy-automation/tree/v0.4).
1716
18-
This script will set up your server with the *nginx-proxy*, which will enable you to host multiple sites,
19-
auto renewing Let´s Encrypt certificates.
17+
## Video Tutorial
2018

21-
Something like:
22-
23-
![Web Proxy environment](https://github.com/evertramos/images/raw/master/webproxy.jpg)
19+
I made a 5 minutes tutorial video to walk you through this project:
2420

21+
[![NGINX-Proxy-Automation](https://img.youtube.com/vi/E9BtHVr_v9I/0.jpg)](https://www.youtube.com/watch?v=E9BtHVr_v9I)
2522

2623
## Prerequisites
2724

@@ -48,7 +45,7 @@ Also, you will need to make sure you have:
4845

4946
## How to use it
5047

51-
1. Clone this repository:
48+
1. Clone this repository **using the option _--recurse-submodules_**:
5249

5350
```bash
5451
$ git clone --recurse-submodules https://github.com/evertramos/nginx-proxy-automation.git proxy
@@ -222,5 +219,7 @@ Credits goes to:
222219
- [@buchdag](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion/pull/226#event-1145800062)
223220
- [@fracz](https://github.com/fracz) - Many contributions!
224221

225-
# Support this project at [Patreon](https://www.patreon.com/evertramos)
226-
[https://www.patreon.com/evertramos](https://www.patreon.com/evertramos)
222+
### Just in case you are willing to support this project, you will find us at:
223+
224+
- [Patreon (evertramos)](https://www.patreon.com/evertramos)
225+
- [Open Collective (nginx-proxy-automation)](https://opencollective.com/nginx-proxy-automation)

docs/requirements.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Requirements to run this automation script
2+
3+
4+
## Environment
5+
- Linux
6+
7+
## Softwares
8+
- Bash
9+
- Docker
10+
- Docker Compose
11+
- Git
12+
- Curl
13+
- Dpkg
14+
- Md5sum
15+
16+
## Used functions
17+
- sudo
18+
- source
19+
- cd
20+
- cp
21+
- mv
22+
- dirname
23+
- type
24+
- command
25+
- systemctl
26+
- echo
27+
- printf
28+
- read
29+
- sed
30+
- awk
31+
- wget
32+
- cat
33+
- cut
34+
- head
35+
- tr
36+
- grep
37+
- rm
38+
- trap
39+
- dpkg
40+
- tput
41+
- md5sum
42+
- ip
43+
- git
44+
- docker
45+
- docker-compose
46+
- curl

0 commit comments

Comments
 (0)