Anpassungen AllTec
Fork von 42wim/Caddy-Gitea
Anpassungen, damit standardmäßig die gitea-pages
-Branch genutzt wird für die Pages-Seiten.
Ansonsten wird immer die main
-Branch genutzt, macht es etwas umständlich:
- entweder muss man entsprechend lange URLs nutzen um manuell auf eine andere Branch zu setzen siehe DNS-Config oder
- man muss immer die Ergebnisse eines Builds in die
main
-Branch pushen. Und muss trotzdem den Ordner, wo die html-Files liegen immer mitführen.
In der gitea-pages.toml
kann nun auch per defaultref
die Branch manuell übergeben werden.
caddy-gitea
Gitea plugin for Caddy v2.
This allows you to have github pages (with more features) in Gitea.
This also requires you to setup a wildcard CNAME to your gitea host.
For now markdown files (with .md
extension) will also be automatically generated to HTML.
Getting started
Caddy config
The Caddyfile below creates a webserver listening on :3000 which will interact with gitea on https://yourgitea.yourdomain.com using agiteatoken
as the token.
The agiteatoken should be a token from gitea that has the necessary read rights on the repo's that you want to expose.
{
order gitea before file_server
}
:3000
gitea {
server https://yourgitea.yourdomain.com
token agiteatoken
domain pages.yourdomain.com #this is optional
}
DNS config
This works with a wildcard domain. So you'll need to make a *.pages.yourdomain.com CNAME to the server you'll be running caddy on.
(this doesn't need to be the same server as gitea).
Depending on the gitea config below you'll be able to access your pages using:
Gitea config
There are multiple options to expose your repo's as a page, that you can use both at the same time.
- creating a gitea-pages repo with a gitea-pages branch and a gitea-pages topic
- adding a gitea-pages branch to any repo of choice and a gitea-pages topic
- adding a gitea-pages-allowall topic to your repo (easiest, but less secure)
gitea-pages repo
e.g. we'll use the yourorg
org.
- create a
gitea-pages
repo in yourorg
org
- Add a
gitea-pages
topic to this gitea-pages
repo (this is used to opt-in your repo),
- Create a
gitea-pages
branch in this gitea-pages
repo.
- Put your content in this branch. (eg file.html)
Your content will now be available on http://yourorg.pages.yourdomain.com:3000/file.html
any repo with configurable allowed branch/tag/commits
e.g. we'll use the yourrepo
repo in the yourorg
org and there is a file.html
in the master
branch and a otherfile.html
in the dev
branch. The master
branch is your default branch.
- Add a
gitea-pages
topic to the yourrepo
repo (this is used to opt-in your repo).
- Create a
gitea-pages
branch in this yourrepo
repo.
- Put a
gitea-pages.toml
file in this gitea-pages
branch of yourrepo
repo. (more info about the content below)
The gitea-pages.toml
file will contain the git reference (branch/tag/commit) you allow to be exposed.
To allow everything use the example below:
allowedrefs=["*"]
To only allow main and dev:
allowedrefs=["main","dev"]
e.g. we'll use the yourrepo
repo in the yourorg
org and there is a file.html
in the master
branch and a otherfile.html
in the dev
branch. The master
branch is your default branch.
- Add a
gitea-pages-allowall
topic to the yourrepo
repo (this is used to opt-in your repo).
Building caddy
As this is a 3rd party plugin you'll need to build caddy (or use the binaries).
To build with this plugin you'll need to have go1.19 installed.
go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest #this will install xcaddy in ~/go/bin
~/go/bin/xcaddy build --with github.com/42wim/caddy-gitea@v0.0.4