From bd98d78b8bc06577759e546ad51ebb9932798f12 Mon Sep 17 00:00:00 2001 From: Ronmi Ren Date: Mon, 13 Jan 2025 16:51:07 +0800 Subject: [PATCH] update readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c628cd..e91b1f1 100644 --- a/README.md +++ b/README.md @@ -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?