GitRiver GitRiver
RU
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

  1. Open the repository -> “Settings” -> Pages section
  2. Enable “Pages enabled”
  3. Choose the source:
    • CI - deploy from a CI pipeline (default). A job named pages must create a public/ directory in its artifacts
    • Manual - upload a ZIP via the interface
  4. Specify the branch (default is main)
  5. Optionally enable SPA mode - if a file is not found, index.html is 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)

  1. Open the repository -> Pages -> “Upload”
  2. Select a ZIP archive with the site files
  3. 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:

  1. Open Pages -> “Domains” -> “Add domain”
  2. Enter the domain (e.g., docs.example.com)
  3. GitRiver will generate a verification token
  4. Create a DNS TXT record: _gitriver-pages.docs.example.com with the token value
  5. Click “Verify” - GitRiver will check DNS
  6. 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

  1. Open the repository -> “Wiki” tab
  2. On first visit, the Wiki is created automatically
  3. Click “New page”
  4. Enter a title (a slug is generated from it: My Page -> My-Page)
  5. Write the content in Markdown
  6. Optionally specify a commit message
  7. Click “Save”

Editing

  1. Open a Wiki page
  2. Click “Edit”
  3. Modify the content
  4. 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:

  1. Open a Wiki page
  2. Click “History”
  3. You will see a list of commits: author, date, message

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).