You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,34 +1,32 @@
1
1
# gitea-pages
2
2
3
-
> Next-generation Gitea Pages, replacing the previous caddy-gitea-proxy
3
+
> The next generation Gitea Pages, replacing the previous `caddy-gitea-proxy`
4
4
5
5
**This project is part of Dragon's Zone HomeLab**
6
6
7
-
This project focuses on functional implementation and does not consider any performance optimizations or large-scale
8
-
deployment scenarios. Any issues arising from this are not related to the project.
7
+
This project focuses on functionality implementation and does not consider any performance optimizations or large-scale deployment scenarios. Any issues arising from this are not related to the project.
9
8
10
-
**Note**: The project recently added custom renderers and reverse proxy functionality, which may lead to serious
11
-
security and performance issues. If not needed, it can be turned off in the settings.
9
+
**Note**: This project has been completely refactored and is not compatible with upgrades from version `0.0.1`
12
10
13
11
## Get Started
14
12
15
-
Install `go1.25` or later, along with the `Make` tool, and then execute the following command:
13
+
Install `go1.25` or higher, and also install the `Make` tool, then execute the following command:
16
14
17
15
```bash
18
16
make gitea-pages
19
17
```
20
18
21
-
After that, you can start it using the following command:
19
+
After that, you can start it with the following command:
22
20
23
21
```bash
24
22
./gitea-pages -conf config.yaml
25
23
```
26
24
27
-
For specific configurations, check[`config.yaml`](./config.yaml).
25
+
For specific configurations, see[`config.yaml`](./config.yaml).
28
26
29
27
### Page Config
30
28
31
-
Create `.pages.yaml` in the project's `gh-pages` branch and fill in the following content:
29
+
Create a `.pages.yaml`file in the `gh-pages` branch of your project and fill in the following content:
32
30
33
31
```yaml
34
32
alias: # CNAME
@@ -46,9 +44,11 @@ routes:
46
44
- [x] CNAME custom domains
47
45
- [x] Template rendering
48
46
- [x] Reverse proxy requests
49
-
- [ ] OAuth2 authorized access to private pages
50
-
- [ ] ~~http01 auto-certificate issuance~~: Handled by Caddy
51
-
- [ ] ~~Webhook-triggered updates~~: Not a high priority for real-time needs
47
+
- [ ] Support CORS
48
+
- [ ] Support custom caching strategies (HTTP cache-control)
49
+
- [ ] OAuth2 authorization for accessing private pages
50
+
- [ ] ~~http01 automatic certificate issuance~~: Handled by Caddy
51
+
- [ ] ~~Web hook triggers for updates~~: Not a high priority for real-time needs
0 commit comments