giteapages/README.md

29 lines
603 B
Markdown
Raw Normal View History

2024-11-28 01:45:01 +00:00
# Purpose
This tool allows to serve static files of a git repo hosted on a gitea instance
Files to be served must be published in a branch named "pages" and in a folder named "public"
# Usage
## standalone
set GITDOMAIN environment variable, then run `go run main.go 8081`
## Docker
Build image using docker and run a container, setting GITDOMAIN environment variable
# Limitations
* serve only public repo
* only relative links are supported
# Further
* perform security audit
* find a way to serve private repo content
* propose a standard gitea action to publish content
* custom domains