Rustelo/templates/website-htmx-ssr/TEMPLATE-SETUP.md
2026-07-18 19:57:03 +01:00

2 KiB

Template setup — complete these before going live

This site was generated from a Rustelo website template (a sanitized snapshot of a living site). It builds and runs with placeholder defaults. Replace each item below. Search the tree for example.com, Your Name, and # COMPLETE: to find spots.

1. Identity (required)

  • site/config/site.ncl — site name, languages, default language.
  • site/config/seo.ncl / server.nclbase_url (currently https://example.com).
  • Author/byline strings in crates/*/templates/pages/about.j2, contact.j2.

2. Branding (required)

  • Logos were not shipped. Add yours under site/public/images/logos/ and point site/config/site.ncl logo.* at them.
  • Theme: site/assets/styles/themes/*.toml + uno.config.ts.

3. Content (required)

  • Replace the example post: site/content/blog/{en,es}/getting-started/.
  • Add pages under site/content/pages/ and routes in site/config/routes.ncl.

4. Secrets & services (required for auth/email/deploy)

  • Copy .env.example.env; fill session secret, DB URL, SMTP/OAuth.
  • site/config/{email.ncl,external-services.ncl,auth.toml} — providers.

5. Deploy (required only to ship images)

  • provisioning/project.ncl — namespace, image ref, PVC, pull secret (registry-pull-secret), TLS issuer/zone. All default to example.com.
  • lian-build/build_directives.ncl — registry (registry.example.com), signing, cache, secrets base (secrets-base).
  • provisioning/build.nuSECRETS_BASE env / workspace.

6. Render profile

  • site/config/rendering.ncl default_profile is preset for this template's mode. Switch profiles only with a matching build (just build-auto auto-detects).

7. ontoref (optional)

  • If you chose ontoref onboarding, .ontoref/ governs this project. Run ONTOREF_ACTOR=agent ontoref describe project to verify. The rustelo domain ontology is referenced (not copied) via .rustelo.ontoref.

Delete this file once setup is done.