From a5fde70d03d1e496619ba4abbc1220742126ac93 Mon Sep 17 00:00:00 2001 From: Adrian Rangel Date: Mon, 24 Jun 2024 13:59:52 -0600 Subject: [PATCH] add documentation on publishing private repos status website --- docs/configuration.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 63475e6..273c09d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -436,6 +436,15 @@ status-website: robotsText: "User-agent: * \n Disallow: /" ``` +#### Enable status page for private repositories + +By default, status websites for private repositories are not published to enhance security and prevent the accidental exposure of private data. +If you have a private repository and wish to publish your status website, you need to explicitly set the publish option to true in your configuration. +```yaml +status-website: + publish: true +``` + #### Custom API base URL By default, Upptime uses the official GitHub API to fetch data for your status page website. If you have a proxy API (perhaps using a personal access token with readonly access to your private repository), you can set the `apiBaseUrl` key under `status-website`: