CoffeeGit.page | Private.coffee Git Pages

Getting Started

CoffeeGit.page allows you to host static websites directly from your Private.coffee Git repositories. Each repository can be published to a subdomain of CoffeeGit.page or to your own custom domain.

Note: Your repository must be public to be served via CoffeeGit.page.

Basic Setup

By default, your repository will be available at https://username.coffeegit.page/repository-name. The content from the pages branch will be served by default.

Custom Domains

You can configure your repository to be served from a custom domain or subdomain.

Step 1: Create a .domains file

Add a .domains file to the root of your pages branch. Each line in this file should contain a domain you want to use:

example.com
www.example.com
blog.example.com

Step 2: Configure DNS

You need to set up either a CNAME record or a combination of A/AAAA and TXT records with your DNS provider. The following examples show how to use the repository repository owned by the username user as a target, using the default pages branch. If you want to use a different branch, simply use the branch.repository.username.coffeegit.page syntax.

Option A: CNAME Record (Recommended for subdomains)

# For a subdomain like blog.example.com
Host: blog.example.com.
Type: CNAME
Value: repository.username.coffeegit.page.

Option B: A/AAAA + TXT Record (For apex/root domains)

# For an apex domain like example.com
Host: example.com.
Type: TXT
Value: repository.username.coffeegit.page.

Additionally, you'll need to set up A and AAAA records for apex domains:

Host: example.com.
Type: A
Value: 195.20.104.17

Host: example.com.
Type: AAAA
Value: 2a0c:b641:d10:117::1

Important: DNS changes may take up to 24 hours to propagate. Once propagated, your site will be available at your custom domain.

Advanced Configuration

Custom 404 Pages

Create a 404.html file in your repository to display a custom error page when visitors try to access non-existent pages.

Static Site Generators

You can use static site generators like Hugo, Jekyll, or Eleventy. Just make sure your repository's pages branch contains the built static files in the root directory.

Troubleshooting

Site Not Updating

Changes may take a few minutes to appear. If your site isn't updating after pushing changes:

Make sure your repository is public
Check that you're using the correct branch
Verify that your site doesn't have build errors

Custom Domain Not Working

If your custom domain isn't working:

Verify that the domain is correctly listed in the .domains file
Check your DNS configuration with a tool like DNSChecker
Remember that DNS changes can take up to 24 hours to propagate