Getting started with an HTML site

This is the simpler site path: Everlock serves the files in the repository as they are.

1. Enable the required backends

/backends enable site-http git-ssh

Reconnect after restart if needed.

Expected result:

  enabled: site-http, git-ssh
  restart required

2. Create the site

/site create my-html-site vhost=localhost mode=html

Expected output shape:

  Site 'my-html-site' created (store: my-html-site, auth: public).
  Granted admin write access to push content: */git/my-html-site

3. Clone the store

git clone ssh://admin@localhost:2222/my-html-site
cd my-html-site

4. Add files

Create a minimal site:

cat > index.html <<'EOF'
<html>
<body>
  <h1>Hello from Everlock</h1>
  <p>This site is served directly from a Git-backed repository.</p>
</body>
</html>
EOF

5. Commit and push

git add index.html
git commit -m "initial HTML site"
git push

Everlock serves the new content immediately after the push.

Expected result:

git push succeeds like a normal Git push
the page becomes available immediately over the configured vhost

What to expect

/ serves index.html
assets such as CSS, JS, images, and SVGs are served directly
there is no rendering step between the repository and the HTTP response

When to use this mode

Choose html when:

you already have prebuilt static output
you want full control over the generated HTML
you do not need Everlock's Markdown-specific features