style README.md more
This commit is contained in:
parent
6d277e052d
commit
5cdf3b3965
23
README.md
23
README.md
@ -20,16 +20,23 @@ A recipe for generating static websites with [Hugo](https://gohugo.io) and a lis
|
||||
|
||||
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
|
||||
|
||||
### Modes
|
||||
## Modes
|
||||
|
||||
#### Public
|
||||
There are three different types of deployments currently supported:
|
||||
|
||||
- Public Site & Repo
|
||||
- Public Site & Private Repo
|
||||
- Private Site & Repo
|
||||
|
||||
### Public
|
||||
|
||||
The default deployment is **fully public**:
|
||||
|
||||
* `/`: the Hugo site is served
|
||||
* `/deploy`: the webhook to re-build the site, **includes publicly viewable logs**
|
||||
* `/deploy`: triggers `webhookd` to re-build the site, **includes publicly viewable logs**
|
||||
|
||||
#### HTTP Basic Auth
|
||||
|
||||
### HTTP Basic Auth
|
||||
|
||||
If you enable this in your `.env` file:
|
||||
|
||||
@ -47,7 +54,7 @@ When you deploy:
|
||||
* `/`: the Hugo site is served
|
||||
* `/deploy`: the webhook is behind HTTP basic auth
|
||||
|
||||
#### Private Repository
|
||||
### Private Repository
|
||||
|
||||
If you enable this in your `.env` file:
|
||||
|
||||
@ -99,7 +106,7 @@ You can then deploy and the deploy key will be loaded before cloning the private
|
||||
repository and all should nicely.
|
||||
|
||||
|
||||
#### HTTP Basic Auth & Private repository
|
||||
### HTTP Basic Auth & Private Repository
|
||||
|
||||
Combine them with the `COMPOSE_FILE` technique:
|
||||
|
||||
@ -107,7 +114,9 @@ Combine them with the `COMPOSE_FILE` technique:
|
||||
COMPOSE_FILE="compose.yml:compose.auth.yml:compose.private.yml"
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
This is a WIP, there are likely dragons and foot cannons. Ye be warned.
|
||||
|
||||
#### Site not generating?
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user