updated readme

This commit is contained in:
Josia Pietsch 2024-02-22 16:27:34 +01:00
parent 7e021be0b8
commit e9f147331d
Signed by: josia
GPG key ID: E70B571D66986A2D

View file

@ -31,11 +31,12 @@ with `sudo chmod 600 <STORAGE_ROOT>`.
### Settting up a new repository
For each new repository, you want to do the following:
Run `setup-key.sh <owner>/<repository>` to generate a ssh keypair and set up the `pages` user to accept this.
Here, `<owner>/<repository>` can be anything, it will be the path relative to the webroot where this ssh key
Run `setup-key.sh <owner> <repository>` to generate a ssh keypair and set up the `pages` user to accept this.
Here, `<owner>` and `<repository>` can be anything, it will be the path relative to the webroot where this ssh key
will be able to deploy to, but this would be the recommended pattern for git instances.
In your repository, add the displayed ssh key as a secret named `PAGES_SSH_KEY`.
In your repository, add the displayed ssh key as a secret (Settings -> Actions -> Secrets, note that Actions need to be enabled, see Settings -> Repository -> Advanced Settings)
named `PAGES_SSH_KEY`.
Now you should be fine to use the action as described in [actions/pages][action-pages].
[git]: https://git.abstractnonsen.se