Note: This guide assumes that you’ve configured your site as a flake.

On GitHub Pages

To deploy your site on GitHub Pages, set your settings to deploy from an Action and tweak this workflow to your liking:

name: Deploy site to Pages

    branches: ["master"]

  contents: read
  pages: write
  id-token: write

  group: "pages"
  cancel-in-progress: true

      name: github-pages
      url: $!
    runs-on: ubuntu-latest
      - uses: actions/checkout@v3
      - uses: DeterminateSystems/nix-installer-action@v9
      - uses: DeterminateSystems/magic-nix-cache-action@v2
      - uses: actions/configure-pages@v2
      - name: Build Site
        run: 'nix build .'
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
          path: './result'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

In a Container

The starting flake configuration contains a container output. This uses Packsnap’s custom plan builder to build a very small container with only your site and the Caddy web server. To build it and make Docker aware of it, just run:

nix build '.#container'
docker load < result

Note: The image will only work if built on Linux.

This built image can then be pushed to a registry and deployed anywhere. The webserver runs on container port 80.

Deploying on Railway

To deploy a Cheetah site on Railway, as an example, you can use a GitHub Action to build a container and publish it to GHCR, and then you can use Railway’s OCI image deployment functionality to deploy it.

If you need help, ping me (@aleks) on the Railway Discord server.