Getting Started

Local install

Installing Nitropage locally gives you access to the underlying SolidStart project and a copy of all starter kit blueprints. This installation method allows you freely customize the whole project including the blueprints and to create your own ones.

Keep in mind that this method does not allow automatic updates! Learn how to manually update local installation in the Updates article.

Requirements

• Operating system: Unix-based or WSL
• Node.js: LTS (>= v22) - Download
• PNPM: Optional, but highly recommended - Download
  Fast and efficient dependency installations!

1. Initialize a new Nitropage project using the CLI:

   pnpm create nitropage@latest <project-name>
   # or
   npm create nitropage@latest <project-name>
   

   When it asks you, choose to install dependencies and initialize the sqlite database.

2. Start up the development server:

   cd <project-name>
   pnpm dev 
   # or 
   npm run dev
   

Docker

Docker is a great way to give Nitropage a try and to host basic websites with limited extensibility. This guide assumes that Docker is installed on your system and is ready to go.

1. Create a compose.yaml file with the following content:

   services:
     nitropage:
       restart: always
       image: nitropage/nitropage:sqlite
       env_file: ".env"
       volumes:
         - ./.data:/app/.data
       ports:
         - 3000:3000
       healthcheck:
         test: ["CMD", "curl", "-f", "http://127.0.0.1:3000/admin"]
         interval: 2s
         timeout: 10s
         retries: 15
   

2. Create an .env file with the following content:

   DATABASE_URL=file:../.data/dev.db
   NP_AUTH_SALT=random_characters
   NP_AUTH_PASSWORD=this_must_be_at_least_32_characters
   

   Change NP_AUTH_SALT and NP_AUTH_PASSWORD to your liking or generate random values with the command: openssl rand -hex 16

3. Start the container:

   docker-compose up -d
   

Wanna use a PostgreSQL database? Take a look at the following example: compose.yaml

Coolify

With Coolify you can easily self-host a wide range of services including Nitropage. It is completely open source and is constantly being improved!

Coolify itself can be used through two ways:

• Coolify Cloud
• Self-hosted

Railway

If you want to set up a website with Nitropage as easily as possible, Railway is the perfect solution. It is a cloud hosting provider focusing on simplicity and user experience.

We maintain two Railway templates, that both allow you to install Nitropage with few clicks:

• Minimal (SQLite): Stores all of your data in a single file. Ideal for small and portable websites.
• Advanced (PostgreSQL): If you expect a lot of traffic this is the way to go.