Navigation
Pages and Wiki
Hosting static websites from a repository and built-in Wiki with revision history
Pages - Static Websites
GitRiver can host static websites directly from a repository: documentation, landing pages, SPAs. Files are served from your domain, without external hosting.
Enabling Pages
- Open the repository -> “Settings” -> Pages section
- Enable “Pages enabled”
- Choose the source:
- CI - deploy from a CI pipeline (default). A job named
pagesmust create apublic/directory in its artifacts - Manual - upload a ZIP via the interface
- CI - deploy from a CI pipeline (default). A job named
- Specify the branch (default is
main) - Optionally enable SPA mode - if a file is not found,
index.htmlis returned (for React, Vue, Angular)
Deploying from CI
Create a workflow .gitriver/workflows/pages.yml:
name: Pages
on:
push:
branches: [main]
jobs:
pages:
image: node:22
steps:
- run: npm ci
- run: npm run build
artifacts:
paths:
- public/
Important: the public/ directory must be in the artifacts of a job named pages (or the name specified in settings). After the pipeline completes successfully, the site will update automatically.
Manual Deploy (ZIP)
- Open the repository -> Pages -> “Upload”
- Select a ZIP archive with the site files
- Click “Upload”
Limits: up to 1 GB unpacked size, up to 10,000 files.
Viewing the Site
The site is available at: https://git.example.com/_pages/{owner}/{repository}/
For private repositories - authentication is required.
Custom Domains
To attach your own domain:
- Open Pages -> “Domains” -> “Add domain”
- Enter the domain (e.g.,
docs.example.com) - GitRiver will generate a verification token
- Create a DNS TXT record:
_gitriver-pages.docs.example.comwith the token value - Click “Verify” - GitRiver will check DNS
- After verification, point the domain to the GitRiver server IP (A record or CNAME)
Deploy History
The Pages page displays recent deploys: status, size, date, author. Old deploys are deleted automatically (the last 5 are kept).
Wiki
Wiki is built-in documentation for a repository. Pages are written in Markdown and stored in a separate git repository (without cluttering the main code).
Creating a Page
- Open the repository -> “Wiki” tab
- On first visit, the Wiki is created automatically
- Click “New page”
- Enter a title (a slug is generated from it:
My Page->My-Page) - Write the content in Markdown
- Optionally specify a commit message
- Click “Save”
Editing
- Open a Wiki page
- Click “Edit”
- Modify the content
- Save - changes are recorded as a git commit
Renaming
When editing, change the title - the page will be renamed (the old slug is deleted, a new one is created).
Revision History
Every change is a git commit. To view the history:
- Open a Wiki page
- Click “History”
- You will see a list of commits: author, date, message
Sidebar Navigation
If a page named _Sidebar exists in the Wiki, its content is displayed in the sidebar on all pages. If _Sidebar doesn’t exist - navigation is generated automatically from the list of pages.
Example _Sidebar:
### Navigation
- [Home](/owner/repo/wiki/Home)
- [Installation](/owner/repo/wiki/Installation)
- [API](/owner/repo/wiki/API)
Deleting a Page
Open the page -> “Delete”. Deletion is irreversible (but can be recovered through the git history of the wiki repository).