From eab5e59a44352d8358f92dd11591abfc93bdb328 Mon Sep 17 00:00:00 2001 From: meetqy Date: Tue, 2 Jan 2024 10:50:23 +0800 Subject: [PATCH] readme --- README-EN.md | 63 +++++++++++++++++++++++----------------------------- README.md | 2 +- 2 files changed, 29 insertions(+), 36 deletions(-) diff --git a/README-EN.md b/README-EN.md index 51033b75..9af4c082 100644 --- a/README-EN.md +++ b/README-EN.md @@ -67,44 +67,37 @@ PC - 📌 The default theme supports PWA, you can save it as an app without opening the browser every time - 🎊 Can access materials without relying on management software, and can even be deployed on Windows/MacOS servers -## Contribution - -We welcome anyone interested in helping to improve Rao.Pics. If you want to contribute, there are several ways to participate: - -- Bug fixes: If you find a bug, please create a pull request with a clear description of the problem and the solution. Quick entry => [🐞 Submit Bug](https://github.com/meetqy/rao-pics/issues/new?assignees=&labels=Bug&projects=&template=bug_report.yml&title=bug%3A+) - -- Improvements: Do you have any ideas to improve Rao.Pics? Please create an issue first to discuss why this improvement is needed. Quick entry => [🛠 Feature Request](https://github.com/meetqy/rao-pics/issues/new?assignees=&labels=%E2%9C%A8+enhancement&projects=&template=feature_request.yml&title=feat%3A+) - -## Build - -These commands are for maintainers only. - -**Environment Information** - -- nodejs >= `v18.17.1` -- pnpm >= `8.7.6` - -**Pull the code** - +## Custom Domain + +Using `Nginx` as an example, let's say you want to customize the domain to `desktop.rao.pics`. + +1. In the App/Settings, enter `https://desktop.rao.pics`. +2. Configure Nginx as follows: + +```nginx +server { + listen 80; + server_name desktop.rao.pics; + + location / { + proxy_pass http://localhost:61121; # App/设置 中的网页端口 + proxy_set_header Host $proxy_host; + proxy_set_header X-Real-Ip $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + } + + location /trpc { + proxy_pass http://localhost:61122; # App/设置 中的服务端口 + proxy_set_header Host $proxy_host; + proxy_set_header X-Real-Ip $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + } +} ``` -git clone https://github.com/meetqy/rao-pics.git -``` - -**Install Dependencies** - -Install dependencies using pnpm -``` -pnpm i -``` +## Contribute -**Run** - -`pnpm dev` will run three projects simultaneously: `packages/db`, `themes/gallery`, `apps/electron` - -``` -pnpm dev -``` +[贡献指南](./CONTRIBUTING.md) ## Support the Author diff --git a/README.md b/README.md index 65b6f877..99d4405a 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ PC 以 `Nginx` 作为示例,假设需要自定义的域名为:`desktop.rao.pics` 1. 在 App/设置 中,填写 `https://desktop.rao.pics`。 -2. nginx 中配置 +2. Nginx 中配置 ```nginx server {