Skip to content

Commit c151bb4

Browse files
committed
feat: update readme
1 parent 29a27ad commit c151bb4

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
# Installation
2525
To customize your Comet experience to suit your needs, please first take a look at all the [environment variables](https://github.com/g0ldyy/comet/blob/main/.env-sample)!
26+
2627
## ElfHosted
2728
A free, public Comet instance is available at https://comet.elfhosted.com
2829

@@ -53,7 +54,7 @@ ElfHosted offer "one-click" [private Comet instances](https://elfhosted.com/app/
5354
````
5455

5556
### With Docker Compose
56-
- Copy *docker-compose.yaml* in a directory
57+
- Copy *deployment/docker-compose.yml* in a directory
5758
- Copy *.env-sample* to *.env* in the same directory and keep only the variables you wish to modify, also remove all comments
5859
- Pull the latest version from docker hub
5960
```sh
@@ -64,8 +65,21 @@ ElfHosted offer "one-click" [private Comet instances](https://elfhosted.com/app/
6465
docker compose up -d
6566
```
6667

67-
## Debrid IP Blacklist
68-
To bypass Real-Debrid's (or AllDebrid) IP blacklist, start a cloudflare-warp container: https://github.com/cmj2002/warp-docker
68+
### Nginx Reverse Proxy
69+
If you want to serve Comet via a Nginx Reverse Proxy, here's the configuration you should use.
70+
```
71+
server {
72+
server_name example.com;
73+
74+
location / {
75+
proxy_pass http://localhost:8000;
76+
proxy_set_header Host $host;
77+
proxy_set_header X-Real-IP $remote_addr;
78+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
79+
proxy_set_header X-Forwarded-Proto $scheme;
80+
}
81+
}
82+
```
6983
7084
## Web UI Showcase
7185
<img src="https://i.imgur.com/SaD365F.png" />
File renamed without changes.

deployment/nginx.conf

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
server {
2+
server_name example.com;
3+
4+
location / {
5+
proxy_pass http://localhost:8000;
6+
proxy_set_header Host $host;
7+
proxy_set_header X-Real-IP $remote_addr;
8+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
9+
proxy_set_header X-Forwarded-Proto $scheme;
10+
}
11+
}

0 commit comments

Comments
 (0)