tenkuma/forgejo-pages
tenkuma/forgejo-pages
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Ronmi Ren 2025-01-13 16:51:07 +08:00
commit bd98d78b8b
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -14,7 +14,7 @@ This mode is good for simple setup, like, you have small number of viewers, or y
### Webhook mode
Webhook mode is a tool which helps you to download latest content via git. You'll have to setup a webhook in forgejo server in order to notify it when to download new content.
Webhook mode is a tool which helps you to download latest content via git. You'll have to setup a webhook in forgejo server in order to notify it when to download new content. You have to have `git` binary in your path.
To serve downloaded pages, you'll have to use a web server like Nginx.
@ -41,9 +41,13 @@ Take care about permissions of the API token. For serve mode, repositories the k
```
docker run -p 8080:8080 --user 1000:1000 ronmi/forgejo-pages serve -s https://git.example.com -k my-secret-token
docker run -p 8080:8080 --user 1000:1000 -v `pwd`/data:/data ronmi/forgejo-pages listen -u myuser -k my-secret-token -s https://git.example.com -a :8080 -b static-pages -d /data
docker run -p 8080:8080 --user 1000:1000 -v `pwd`/data:/data ronmi/forgejo-pages:git listen -u myuser -k my-secret-token -s https://git.example.com -a :8080 -b static-pages -d /data
```
Serve mode could use `latest` tag, a minimal image contains only libc, CA certificates, timezone data and page server binary.
Webhook mode should use `git` tag.
# FAQ
### Can I use user.example.com/repo/path format?