Starting the Database

Start the NukeBase server with configuration options by calling startDB() once at the end of your configuration:

// Basic setup - pass the domain object to startDB
const nukebase = addDomain({
  authPath: ["users"],
  host: "127.0.0.1", // optional
  port: 3000 // optional
});

startDB(nukebase);

addDomain Configuration Options:

• authPath: Array - path to user authentication data (e.g., ["users"])
• host: String (optional) - the IP address to bind to
  • Use "127.0.0.1" to accept connections only from the local machine (default)
  • Use a specific IP address like "126.23.45.1" to bind to that server address
  • Use "0.0.0.0" to accept connections from any IP
• port: Number (optional) - the port to listen on (default: 3000)

Environment Variables

The server reads these from the environment. Every one has a working default — you normally set none of them.

Deployment

On the hosted platform

A hosted project's process is started by the platform, so its environment has to come from the platform too. Keep a .env file in your project root — the same file node --env-file=.env server/database.js loads locally — and push it separately from your code:

nukebase env push          # make the hosted environment equal to ./.env, then restart
nukebase env list          # variable names currently set (add --show to print values)

Every variable in the file lands in process.env — your own settings and any of the engine tunables above. env push replaces the whole set, so removing a line locally and pushing removes it on the server. .env is never carried by an ordinary push or pull; on the server it is kept outside the project directory, root-owned, where no sync, ZIP download or restore point can reach it. SOCKET and DOMAIN are set by the platform and are refused. Values are single-line and up to 8 KB each; encode anything multi-line, such as a PEM key, before putting it in the file.

Files

Limits and capacity