Skip to content
CodeFloe

Configuration

Build Configuration

Section titled “Build Configuration”

Statichost looks for a statichost.yml file in the root of your deployment branch.

Configuration File

Section titled “Configuration File”

The statichost.yml file controls how your site is built and served. Here’s an example:

# Container image to use for building
image: alpine:latest

# Build command to execute
command: "echo 'Deploy'"

# Public directory containing your site
public: .

Configuration Options

Section titled “Configuration Options”
  • image: The container image used for building your site (e.g., node:24, python:3.12, alpine:latest)
  • command: The build command to execute (e.g., npm run build, hugo, mkdocs build)
  • public: The directory containing the final static files to serve

Example Configurations

Section titled “Example Configurations”

Static HTML Site

Section titled “Static HTML Site”
image: alpine:latest
command: "echo 'No build needed'"
public: .

Node.js/React/Vue Site

Section titled “Node.js/React/Vue Site”
image: node:24
command: "npm install && npm run build"
public: dist

Hugo Site

Section titled “Hugo Site”
image: hugomods/hugo:latest
command: "hugo"
public: public

MkDocs Site

Section titled “MkDocs Site”
image: python:3.12
command: "pip install mkdocs mkdocs-material && mkdocs build"
public: site

Changing the Pages Branch

Section titled “Changing the Pages Branch”

You can change which branch is used for hosting your site:

  1. Go to your repository’s Settings

  2. Navigate to the Pages section

  3. Select a different branch from the dropdown

  4. Click Save

The site will be redeployed from the new branch automatically.

Custom Domains

Section titled “Custom Domains”

To use a custom domain, you need to configure DNS and then add the domain in CodeFloe.

  1. Configure your DNS

    Section titled “Configure your DNS”

    Create a CNAME entry in your DNS control panel pointing your desired subdomain to:

    codefloe-<owner>-<repo>.codefloe.page

    For example, if your username is techuser and your repository is myproject, create a CNAME record pointing to:

    codefloe-techuser-myproject.codefloe.page

    The “name” of the CNAME should be your desired subdomain.

  2. Add the domain in CodeFloe

    Section titled “Add the domain in CodeFloe”

    1. Go to your repository’s Pages settings

    2. Add your custom domain in the Domains section

    3. Set it as the primary domain

The primary domain is required. Additional domains can be added as aliases.

Next Steps

Section titled “Next Steps”