Skip to main content

IIS Deployment

IIS serves the built docs as static files. Browser editing uses the hosted HyperAI API.

Requirements​

  • Windows with IIS.
  • Node.js and npm matching the installed Docusaurus version.
  • IIS URL Rewrite.
  • An HTTPS website binding for your docs domain.
  • Write access for the deployment account.

Install ARR only when using a reverse-proxy rule.

Build​

From the docs repo:

npm install
npm run build

The output lives in build/. The build includes assets from static/, including plugin template downloads.

Publish the files​

Use the repository's deployment workflows for the existing runner setup.

For a separate IIS host, copy the contents of build/ into the website's physical directory. Preserve any required host configuration outside a directory replaced during deployment.

Configure the HTTPS binding, certificate, and index.html default document. Set url and baseUrl in docusaurus.config.js for your own domain or subpath before building.

Configure routing​

The supplied workflows generate web.config. Their Docusaurus rule serves existing files and directories directly, then sends remaining non-API routes to index.html.

Keep the generated font MIME mappings and compression settings. Confirm URL Rewrite is installed before using rewrite rules.

The generated /api/* rule points to localhost:3001. Retain the rule only when your host has a separately managed service needing this route.

The browser editor calls api.hyperai.io directly. Installing Express or PM2 on the docs host is outside the current editor setup.

Check the site​

  1. Load the home page over HTTPS.
  2. Open a docs page through navigation.
  3. Reload the nested URL directly.
  4. Open an image and a template download.
  5. Check browser console and network failures.
  6. Test the authorized editor flow separately.

Common fixes​

Check URL Rewrite, web.config, the site's physical path, and the configured base URL.

CSS or images fail​

Confirm the full build was copied, rather than only HTML files. Check asset URLs against the deployment path.

Editor requests fail​

Inspect the hosted Docs API response. A healthy static site does not establish account authorization or API availability.

A local API route returns 502​

Check the separately managed proxy target and ARR configuration. The editor's direct hosted API calls use a different route.