From e5f6585ab195ce82f219b2c85028e9cc68438de4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Tue, 17 Oct 2023 19:26:50 +0200 Subject: [PATCH] update readme --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6876680..6641b5e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # actions/pages -GitHub/Gitea action to deploy a static webpage, similar to GitLab actions. +GitHub/Gitea action to deploy a static webpage, similar to GitLab actions +(which Gitea has not implented as of October 2023). -Since Gitea (as of October 2023) does not have an integrated pages feature, -this assumes that you have access to -- a webserver that can serve your files via https -- the ability to add ssh-keys to that server used -- a suitable webroot on your server where that the ci deploys to -and prepared your server accordingly. +With default configuration, on [git.abstractnonsen.se](https://git.abstractnonsen.se), +this is used as an action to deploy pipeline artifacts to +`pages.abstractnonsen.se///`. -See [abstractnonsense/pages](https://git.abstractnonsense.se/abstractnonsense) +See [abstractnonsense/pages](https://git.abstractnonsen.se/abstractnonsense) for scripts and detailed explanations on how to set up the webserver part that you need for this action to work. @@ -30,6 +28,7 @@ Regarding access to the server (defaults in parantheses): - `index-title` (name of repository): Header and title of the generated `index.html`. + ## Example ```