Quick Start
This guide explains how to quickly deploy a site using TuxForge Pages.
1. Create a pages branch
In your repository, create a branch named:
pages
This branch will be used to serve your static website.
If the branch does not exist, the default branch will be used instead.
2. Add your static site
Place your static files in one of the following locations inside the repository:
- Root directory (
/) - site/
- public/
- dist/
- build/
Example structure:
/
├── index.html
├── style.css
└── script.js
Or:
/public
├── index.html
└── assets/
The server will automatically detect where index.html is located.
3. Configure webhook (Gitea / Forgejo)
Go to:
Repository → Settings → Webhooks
Add a new webhook with the following settings:
- Type: Forgejo (or Gitea)
- Target URL: https://pages.example.com
- HTTP Method: POST
- Trigger: Push Events
- Branch Filter: pages
Example:
Target URL: https://pages.example.com
Method: POST
Trigger: Push events
Branch filter: pages
This ensures your site is updated automatically when you push changes.
4. Open your site
Your site will be available at:
https://USERNAME.pages.example.com/REPOSITORY
Example:
https://john.pages.example.com/my-website
5. Optional: Configure .pages file
You can create a .pages file in your repository to configure behavior.
Example:
{
"main-site": true,
"domains": ["example.com"]
}
Options:
main-site:
- When set to true, this repository becomes the default site for the user
- Accessible at: https://USERNAME.pages.example.com
domains:
- List of custom domains
- These domains must point to your server via DNS
- Example: example.com www.example.com
When configured, your site will also be available on those domains.