Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ovnrain committed Nov 11, 2023
1 parent 6946f87 commit 3f89de0
Showing 1 changed file with 73 additions and 15 deletions.
88 changes: 73 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
- [用途](#用途)
- [部署与启动](#部署与启动)
- [Docker 部署(推荐)](#docker-部署推荐)
- [使用 Docker Compose 配合 NGINX 部署](#使用-docker-compose-配合-nginx-部署)
- [启用 https 服务器](#启用-https-服务器)
- [使用代理](#使用代理)
- [Node.js 部署](#nodejs-部署)
- [启用 https 服务器](#启用-https-服务器-1)
- [使用代理](#使用代理-1)
- [使用 PM2 保持服务后台常驻](#使用-pm2-保持服务后台常驻)
- [配合 web 服务器](#配合-web-服务器)
- [Vercel 部署](#vercel-部署)
- [权限校验](#权限校验)
- [1. 使用用户名密码](#1-使用用户名密码)
Expand Down Expand Up @@ -69,6 +69,78 @@ $ docker run -d \

启动一个 Docker 容器,将其名称设置为 `javbus-api`,端口设置为 `8922`,并且自动重启

#### 使用 Docker Compose 配合 NGINX 部署

_以下配置仅为示例,具体配置请根据自己的实际情况进行修改_

docker-compose.yml

```yaml
version: '3.8'

services:
api:
image: ovnrain/javbus-api
restart: unless-stopped
# 端口可选,不配置端口时,NGINX 依然可以通过容器内部网络访问 API
# ports:
# - '3000:3000'

nginx:
image: nginx:stable-alpine
ports:
- '8922:80'
depends_on:
- api
volumes:
- ./html:/usr/share/nginx/html:ro
- ./nginx.conf:/etc/nginx/nginx.conf:ro
- ./logs:/var/log/nginx
restart: unless-stopped
```
nginx.conf
```nginx
# 其他配置省略...

http {
# 其他配置省略...

server {
listen 80;
server_name example.com;

location /api {
proxy_pass http://api:3000;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;

proxy_hide_header Cache-Control;

proxy_cache_bypass $http_upgrade;
proxy_http_version 1.1;
proxy_redirect off;

add_header Cache-Control no-cache;
}

location / {
root /usr/share/nginx/html;
index index.html;
}
}
}
```

启动容器

```shell
$ docker-compose up -d
```

#### 启用 https 服务器

```shell
Expand Down Expand Up @@ -147,20 +219,6 @@ _关于 PM2 的详细使用方法,请参考 [PM2 官方文档](https://pm2.key

服务启动后,在浏览器中访问 [http://localhost:8922](http://localhost:8922) 即可获取结果

### 配合 web 服务器

以上两种方式都可以配合 `NGINX``Caddy` 等一起使用,例如 NGINX 配置如下:

```nginx
location /api {
proxy_pass http://localhost:8922;
proxy_http_version 1.1;
proxy_set_header Host $host;
add_header cache-control "no-cache";
}
```

### Vercel 部署

使用 Vercel 部署的优势在于:
Expand Down

0 comments on commit 3f89de0

Please sign in to comment.