Skip to content

Getting started

Requirements

  • A domain or subdomain for the application.
  • A persistent MongoDB database.
  • Docker Compose or Portainer.
  • The Docker image matching the selected edition.
  • A license key for editions that require one.

First administrator

At first startup, set the administrator seed variables in the stack:

env
NFZ_SEED_ADMIN_ENABLED=true
NFZ_SEED_ADMIN_EMAIL=admin@example.local
NFZ_SEED_ADMIN_USERID=admin@example.local
NFZ_SEED_ADMIN_PASSWORD=replace-with-a-strong-password
NFZ_SEED_ADMIN_NAME=VitePress Builder Administrator

Change the password before real production use.

First check

  1. Open the application.
  2. Sign in with the first administrator.
  3. Open License and check the active edition.
  4. Open Nav to customise the home page.
  5. Open Editor to create or update a page.
  6. Run a build and open /docs.

VitePress Builder production guide.