Rspress

This is an example of how to set up a static site with Rspress on Kinsta’s Static Site Hosting services from a GitHub repository.

Rspress is a Rspack-based Static Site Generator. More information is available on the rspress.dev website.

You can also use this quick start template on Kinsta’s Application Hosting without any additional configuration. If you use Application Hosting, the Start command can be left blank for the web process as Kinsta automatically detects the required command during the first deployment.

Prerequisites

  • Kinsta’s quick start templates are stored and managed in GitHub; therefore, you need a GitHub account to access them.
  • You need to create a MyKinsta account to deploy the static site.

Deploy an Rspress static site

  1. Log in to GitHub and create a new repository from this template (Use this template > Create a new repository): Kinsta – Hello World – Static Site With Rspress.
  2. In MyKinsta, click Static Sites > Add site > select GitHub, click Connect git provider > Authorize, and log in to your GitHub account.
  3. Choose the Hello World Rspress repository, click Continue, and enter the following in the Build settings:
    • Build command: npm run build
    • Node version: lts
    • Publish directory: doc_build

During the deployment process, Kinsta automatically installs dependencies defined in your package.json file. The site is available as soon as the build finishes, and the default Rspress page loads at your site’s URL.

Default page after successful deployment of Rspress.
Default page after successful deployment of Rspress.

Deployment lifecycle

Whenever a deployment is initiated (through creating a static site or re-deploying due to an incoming commit), the build command is run, followed by the deployment of the Publish Directory content.

Was this article helpful?