gitea/gitea-pages
3
0
Fork 0
mirror of https://github.com/simongregorebner/gitea-pages.git synced 2025-05-03 14:50:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ebner 2025-03-03 15:17:45 +01:00
parent 7f2f378741
commit 02fae34477
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Readme.md
View File

@ -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>__ __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 ## Classic Mode
In __classic__ mode the access to the pages goes according to these two patterns: 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>__ __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. 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 # 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_): To run the server in __simple__ mode you need a minimal configuration (filename _Caddyfile_) like this (replace _your-gitea-server_ and _gitea_access_token_):