Skip to content

Commit ae85672

Browse files
committed
chore: update documentation
Signed-off-by: Vitor Mattos <vitor@php.rio>
1 parent 9503704 commit ae85672

File tree

1 file changed

+59
-1
lines changed

1 file changed

+59
-1
lines changed

README.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
1-
# documentation
1+
# Official documentation
22

33
Read https://github.com/nginx-proxy/nginx-proxy and https://github.com/nginx-proxy/docker-letsencrypt-nginx-proxy-companion/
4+
5+
## What is it for
6+
7+
Docker environments where all services are on a single host machine. Managed based on environment variables in each service for proxy configuration.
8+
9+
## Installation
10+
11+
* Clone the repo https://github.com/LibreCodeCoop/nginx-proxy/ in `~/projects`
12+
```bash
13+
git clone https://github.com/LibreCodeCoop/nginx-proxy ~/projects/nginx-proxy
14+
```
15+
* Launch the application
16+
```bash
17+
cd ~/projects/nginx-proxy
18+
docker compose up -d
19+
```
20+
21+
## Backup
22+
* You only need to back up the volumes because they contain the SSL certificates of the subdomains
23+
24+
## Update
25+
26+
* Go to the nginx-proxy folder which should be in `~/projects/nginx-proxy`
27+
* Run the `git status` command to see if there were any changes, evaluate if you can discard or if you need to save the change if there were any
28+
* Update the main project
29+
```bash
30+
git pull origin master
31+
```
32+
* Update the images
33+
```bash
34+
docker compose pull
35+
```
36+
* Raise the containers
37+
```bash
38+
docker compose up -d
39+
```
40+
41+
## Service setup
42+
43+
A service setup may require specific configurations, for example if the service runs on a different port or has a different protocol. In these cases, see the nginx-proxy documentation.
44+
45+
### In subdomains
46+
* You will need to add at least these environments to the server:
47+
```bash
48+
VIRTUAL_HOST=
49+
LETSENCRYPT_HOST=
50+
LETSENCRYPT_EMAIL=
51+
```
52+
### In subdomains and paths
53+
* https://github.com/nginx-proxy/nginx-proxy/tree/main/docs#path-based-routing
54+
* You will almost certainly need this:
55+
* https://github.com/nginx-proxy/nginx-proxy/tree/main/docs#per-virtual_host-location-configuration\
56+
Required:\
57+
For pgadmin to work on the /pgadmin path you will need to add these rules to nginx:
58+
```nginx
59+
proxy_set_header X-Script-Name /pgadmin;
60+
proxy_set_header Host $host;
61+
```

0 commit comments

Comments
 (0)