tildeverse
/
tildepages
5
1
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Update default to raw.codeberg.page & improve documentation on custom domains

This commit is contained in:
Moritz Marquardt 2021-12-10 14:31:58 +01:00
parent 6af6523a0f
commit 73fa2da646
No known key found for this signature in database
GPG Key ID: D5788327BEE388B6
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -2,7 +2,7 @@
- `HOST` & `PORT` (default: `[::]` & `443`): listen address. - `HOST` & `PORT` (default: `[::]` & `443`): listen address.
- `PAGES_DOMAIN` (default: `codeberg.page`): main domain for pages. - `PAGES_DOMAIN` (default: `codeberg.page`): main domain for pages.
- `RAW_DOMAIN` (default: `raw.codeberg.org`): domain for raw resources. - `RAW_DOMAIN` (default: `raw.codeberg.page`): domain for raw resources.
- `GITEA_ROOT` (default: `https://codeberg.org`): root of the upstream Gitea instance. - `GITEA_ROOT` (default: `https://codeberg.org`): root of the upstream Gitea instance.
- `GITEA_API_TOKEN` (default: empty): API token for the Gitea instance to access non-public (e.g. limited) repos. - `GITEA_API_TOKEN` (default: empty): API token for the Gitea instance to access non-public (e.g. limited) repos.
- `RAW_INFO_PAGE` (default: https://docs.codeberg.org/pages/raw-content/): info page for raw resources, shown if no resource is provided. - `RAW_INFO_PAGE` (default: https://docs.codeberg.org/pages/raw-content/): info page for raw resources, shown if no resource is provided.
@ -15,6 +15,7 @@
- `ENABLE_HTTP_SERVER` (default: false): Set this to true to enable the HTTP-01 challenge and redirect all other HTTP requests to HTTPS. Currently only works with port 80. - `ENABLE_HTTP_SERVER` (default: false): Set this to true to enable the HTTP-01 challenge and redirect all other HTTP requests to HTTPS. Currently only works with port 80.
- `DNS_PROVIDER` (default: use self-signed certificate): Code of the ACME DNS provider for the main domain wildcard. - `DNS_PROVIDER` (default: use self-signed certificate): Code of the ACME DNS provider for the main domain wildcard.
See https://go-acme.github.io/lego/dns/ for available values & additional environment variables. See https://go-acme.github.io/lego/dns/ for available values & additional environment variables.
- `DEBUG` (default: false): Set this to true to enable debug logging.
``` ```
// Package main is the new Codeberg Pages server, a solution for serving static pages from Gitea repositories. // Package main is the new Codeberg Pages server, a solution for serving static pages from Gitea repositories.
@ -29,8 +30,10 @@
// www.example.org. IN CNAME main.pages.example.codeberg.page. // www.example.org. IN CNAME main.pages.example.codeberg.page.
// //
// 3) if a CNAME is set for "www.example.org", you can redirect there from the naked domain by adding an ALIAS record // 3) if a CNAME is set for "www.example.org", you can redirect there from the naked domain by adding an ALIAS record
// for "example.org" (if your provider allows ALIAS or similar records): // for "example.org" (if your provider allows ALIAS or similar records, otherwise use A/AAAA), together with a TXT
// record that points to your repo (just like the CNAME record):
// example.org IN ALIAS codeberg.page. // example.org IN ALIAS codeberg.page.
// example.org IN TXT main.pages.example.codeberg.page.
// //
// Certificates are generated, updated and cleaned up automatically via Let's Encrypt through a TLS challenge. // Certificates are generated, updated and cleaned up automatically via Let's Encrypt through a TLS challenge.
``` ```

4
cmd/flags.go
View File

@ -35,14 +35,14 @@ var ServeFlags = []cli.Flag{
Name: "raw-domain", Name: "raw-domain",
Usage: "specifies the domain from which raw repository content shall be served, not set disable raw content hosting", Usage: "specifies the domain from which raw repository content shall be served, not set disable raw content hosting",
EnvVars: []string{"RAW_DOMAIN"}, EnvVars: []string{"RAW_DOMAIN"},
Value: "raw.codeberg.org", Value: "raw.codeberg.page",
}, },
// RawInfoPage will be shown (with a redirect) when trying to access RawDomain directly (or without owner/repo/path). // RawInfoPage will be shown (with a redirect) when trying to access RawDomain directly (or without owner/repo/path).
&cli.StringFlag{ &cli.StringFlag{
Name: "raw-info-page", Name: "raw-info-page",
Usage: "will be shown (with a redirect) when trying to access $RAW_DOMAIN directly (or without owner/repo/path)", Usage: "will be shown (with a redirect) when trying to access $RAW_DOMAIN directly (or without owner/repo/path)",
EnvVars: []string{"RAW_INFO_PAGE"}, EnvVars: []string{"RAW_INFO_PAGE"},
Value: "https://docs.codeberg.org/pages/raw-content/", Value: "https://docs.codeberg.org/codeberg-pages/raw-content/",
}, },
// Server // Server