update readme

This commit is contained in:
Maximilian Keßler 2023-10-17 19:26:50 +02:00
parent 699461c090
commit e5f6585ab1
Signed by: max
GPG key ID: BCC5A619923C0BA5

View file

@ -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/<owner>/<repository>/`.
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
```