From 02fae344778bc42a653fc16f698b8a11e6b2139d Mon Sep 17 00:00:00 2001 From: ebner Date: Mon, 3 Mar 2025 15:17:45 +0100 Subject: [PATCH] update readme --- Readme.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 7b47cac..29966d2 100644 --- a/Readme.md +++ b/Readme.md @@ -17,6 +17,12 @@ In __simple__ mode no special DNS setup is required and the access to the hosted __http(s)://<your-server-hostname>/<organization>/<repository>__ +To create a pages site, just +1. Create a `gitea-pages` branch in any repository of an organization +2. Put your content in this branch. (eg index.html) and push the branch + +After the push the content will be available at: http(s)://<your-server-hostname>/<organization>/<repository> + ## Classic Mode In __classic__ mode the access to the pages goes according to these two patterns: @@ -27,10 +33,26 @@ or __http(s)://<organization>.<your-server-hostname>__ -The latter url scheme with serves the content of the repo named __<organization>.gitea-pages__ of the organization (with default settings). +The latter url scheme with serves the content of the repo named __gitea-pages__ of the organization (with default settings, however you can also set it to github like convention or __<organization>.<repository_suffix>__ ). + + +In this mode you can create pages content like this: + +1. Create a `gitea-pages` repo in any organization +2. Create a `gitea-pages` branch in this `gitea-pages` repository +3. Put your content in this branch. (eg index.html) + +Your content will now be available on https://<organization>.<your-server-domain>/index.html + + +Beside this you can simply create a `gitea-pages` branch in any repository of the organization and push it to the gitea server. +These pages are then available at: https://<organization>.<your-server-domain>/ + + Classic mode requires that you setup a _wildcard CNAME_ in DNS for your gitea pages host (see below for more details). You also need a _wildcard HTTPS_ certificate if you want to run with HTTPS. + # Usage To run the server in __simple__ mode you need a minimal configuration (filename _Caddyfile_) like this (replace _your-gitea-server_ and _gitea_access_token_):