Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added clarification to docs about config for custom domains #56

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added clarification to docs about config for custom domains #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,19 @@ status-website:
name: Your Status Website
```

Then, your status page may be hosted on https://user.github.io/repo/, where `user` is your GitHub username and `repo` is your repository name.
Then, your status page may be hosted on https://user.github.io/repo/, where `user` is your GitHub username and `repo` is your repository name.

Note that if you are using a custom domain for your github pages account site (i.e. your user.github.io repo has a custom domain like `example.com`) you will need to use the `cname` **AND** `baseUrl` parameters. This is because github pages will add a slug of your repo name to the end of the custom domain.

```yaml
status-website:
name: Upptime
logoUrl: https://example.com/image.jpg
cname: example.com # Custom CNAME
baseUrl: /upptime # where "repo" is your repository name
```

This configuration will work for `https://example.com/upptime`.

#### Navbar links

Expand Down