Hosting elsewhere

You can host Serverpod anywhere, running Dart directly or through a Docker container. This page contains helpful information if you want to deploy Serverpod on a custom platform.

Required services

Serverpod will not run without a link to a Postgres database with the correct tables added. Serverpod can also optionally use Redis. You enable Redis in your configuration files.

Configuration files

Serverpod has three main configuration files, depending on which mode the server is running; development, staging, or production. The files are located in the config/ directory. By default, the server will start in development mode. To use another configuration file, use the --mode option when starting the server. If you are running multiple servers in a cluster, use the --server-id option to specify the id of each server. By default, the server will run as id default. For instance, to start the server in production mode with id 2, run the following command:

$ dart bin/main.dart --mode production --server-id 2

info

It may be totally valid to run all servers with the same id. If you are using something like AWS Fargate it's hard to configure individual server ids.

By default, Serverpod will listen on ports 8080, 8081, and 8082. The ports are used by the API server, Serverpod Insights, and Relic (Serverpod's web server). You can configure the ports in the configuration files. Most often, you will want to place your server or servers behind a load balancer that handles the SSL certificates for your server and maps the traffic to different domain addresses and ports (typically 443 for HTTPS).

Server roles

Serverpod can assume different roles depending on your configuration. If you run Serverpod on a single server or a cluster of servers, you typically will want to use the default monolith role. If you use a serverless service, use the serverless role. When Serverpod runs as a monolith, it will handle all maintenance tasks, such as health checks and future calls. If you run it serverless, you will need to schedule a cron job to start Serverpod in the maintenance role once every minute if you need support for future calls and health checks.

Role	Function
monolith	Handles incoming connections and maintenance tasks. Allows the server to contain a state. Default role.
serverless	Only handles incoming connections.
maintenance	Runs the maintenance tasks once, then exits.

You can specify the role of your server when you launch it by setting the --role argument.

$ dart bin/main.dart --role serverless

Docker container

Running Serverpod through a Docker container is often the best option as it provides a well-defined environment. It's also easy to integrate into your build and deployment process and runs well on most platforms.

You will get a Dockerfile created in your server directory when you set up a new project. The file works out of the box but can be tailored to your needs. The file has no build options, but you can define environment variables when running it. The following variables are supported.

Environment variable	Meaning
runmode	The run mode to start the server in, possible values are development (default), staging, or production.
serverid	Identifier of your server, default is default
logging	Logging mode at startup, default is normal, but you can specify verbose to get more information during startup which can help with debugging.
role	The role that the server will assume, possible values are monolith (default), serverless, or maintenance.