57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
# git-pages
|
|
|
|
> Scalable static site server for Git forges
|
|
|
|
<!-- metadata -->
|
|
|
|
* **Maintainer**: devydave
|
|
* **Category**: Apps
|
|
* **Status**: 0
|
|
* **Image**: [`git-pages`](https://codeberg.org/git-pages/git-pages), 4, upstream
|
|
* **Healthcheck**: Yes
|
|
* **Backups**: No
|
|
* **Email**: No
|
|
* **Tests**: No
|
|
* **SSO**: No
|
|
|
|
<!-- endmetadata -->
|
|
|
|
## Quick start
|
|
|
|
* `abra app new git-pages`
|
|
* `abra app deploy <app-name>`
|
|
|
|
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
|
|
|
|
### Add domain to git-pages
|
|
At the moment the recipe only supports deploying pages with password not with forgejo tokens.
|
|
1. Run the [git-pages-cli](https://codeberg.org/git-pages/git-pages-cli) with the following command to get the challenge string.
|
|
```sh
|
|
$ git-pages-cli https://example.org --challenge # generate a random password
|
|
password: 28a616f4-2fbe-456b-8456-056d1f38e815
|
|
_git-pages-challenge.example.org. 3600 IN TXT "a59ecb58f7256fc5afb6b96892501007b0b65d64f251b1aca749b0fca61d582c"
|
|
$ git-pages-cli https://example.org --password xyz --challenge
|
|
_git-pages-challenge.example.org. 3600 IN TXT "6c47172c027b3c79358f9f8c110886baf4826d9bc2a1c7d0f439cc770ed42dc8"
|
|
$ git-pages-cli https://example.org --password xyz --challenge-bare
|
|
6c47172c027b3c79358f9f8c110886baf4826d9bc2a1c7d0f439cc770ed42dc8
|
|
```
|
|
2. Setup the domain with the challenge string. You need a TXT record lookup at _git-pages-challenge.<your-domain> and the challenge string as the value.
|
|
3. Deploy your website via the [action](https://codeberg.org/git-pages/action)
|
|
```yaml
|
|
name: Publish
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
jobs:
|
|
publish:
|
|
runs-on: docker
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- uses: actions/git-pages@v2
|
|
with:
|
|
site: https://<your-domain>
|
|
server: <app-domain>
|
|
password: ${{ secrets.THE_PASSWORD_FROM_STEP_1 }}
|
|
source: site/ # path to the dir of your site data that should be deployed
|
|
```
|