diff --git a/docs/0.9.10.html b/docs/0.9.10.html index 43caa0380..149fc5265 100644 --- a/docs/0.9.10.html +++ b/docs/0.9.10.html @@ -4,7 +4,7 @@
There are three different ways to configure Serverpod: with environment variables, via yaml config files, or by supplying the dart configuration object to the Serverpod constructor. The environment variables take precedence over the yaml configurations but both can be used simultaneously. The dart configuration object will override any environment variable or config file. The tables show all available configuration options provided in the Serverpod core library.
Environment variable | Config file | Default | Description |
---|---|---|---|
SERVERPOD_API_SERVER_PORT | apiServer.port | 8080 | The port number for the API server |
SERVERPOD_API_SERVER_PUBLIC_HOST | apiServer.publicHost | localhost | The public host address of the API server |
SERVERPOD_API_SERVER_PUBLIC_PORT | apiServer.publicPort | 8080 | The public port number for the API server |
SERVERPOD_API_SERVER_PUBLIC_SCHEME | apiServer.publicScheme | http | The public scheme (http/https) for the API server |
SERVERPOD_INSIGHTS_SERVER_PORT | insightsServer.port | - | The port number for the Insights server |
SERVERPOD_INSIGHTS_SERVER_PUBLIC_HOST | insightsServer.publicHost | - | The public host address of the Insights server |
SERVERPOD_INSIGHTS_SERVER_PUBLIC_PORT | insightsServer.publicPort | - | The public port number for the Insights server |
SERVERPOD_INSIGHTS_SERVER_PUBLIC_SCHEME | insightsServer.publicScheme | - | The public scheme (http/https) for the Insights server |
SERVERPOD_WEB_SERVER_PORT | webServer.port | - | The port number for the Web server |
SERVERPOD_WEB_SERVER_PUBLIC_HOST | webServer.publicHost | - | The public host address of the Web server |
SERVERPOD_WEB_SERVER_PUBLIC_PORT | webServer.publicPort | - | The public port number for the Web server |
SERVERPOD_WEB_SERVER_PUBLIC_SCHEME | webServer.publicScheme | - | The public scheme (http/https) for the Web server |
SERVERPOD_DATABASE_HOST | database.host | - | The host address of the database |
SERVERPOD_DATABASE_PORT | database.port | - | The port number for the database connection |
SERVERPOD_DATABASE_NAME | database.name | - | The name of the database |
SERVERPOD_DATABASE_USER | database.user | - | The user name for database authentication |
SERVERPOD_DATABASE_REQUIRE_SSL | database.requireSsl | false | Indicates if SSL is required for the database |
SERVERPOD_DATABASE_IS_UNIX_SOCKET | database.isUnixSocket | false | Specifies if the database connection is a Unix socket |
SERVERPOD_REDIS_HOST | redis.host | - | The host address of the Redis server |
SERVERPOD_REDIS_PORT | redis.port | - | The port number for the Redis server |
SERVERPOD_REDIS_USER | redis.user | - | The user name for Redis authentication |
SERVERPOD_REDIS_ENABLED | redis.enabled | false | Indicates if Redis is enabled |
SERVERPOD_MAX_REQUEST_SIZE | maxRequestSize | 524288 | The maximum size of requests allowed in bytes |
SERVERPOD_SESSION_PERSISTENT_LOG_ENABLED | sessionLogs.persistentEnabled | - | Enables or disables logging session data to the database. Defaults to true if a database is configured, otherwise false . |
SERVERPOD_SESSION_CONSOLE_LOG_ENABLED | sessionLogs.consoleEnabled | - | Enables or disables logging session data to the console. Defaults to true if no database is configured, otherwise false . |
Environment variable | Passwords file | Default | Description |
---|---|---|---|
SERVERPOD_DATABASE_PASSWORD | database | - | The password for the database |
SERVERPOD_SERVICE_SECRET | serviceSecret | - | The token used to connect with insights must be at least 20 chars |
SERVERPOD_REDIS_PASSWORD | redis | - | The password for the Redis server |
Environment variable | Command line option | Description |
---|---|---|
SERVERPOD_SERVER_ID | --server-id | Configures the id of the server instance. Defaults to default . |
The config file should be named after the run mode you start the server in and it needs to be placed inside the config
directory in the root of the server project. As an example, you have the config/development.yaml
that will be used when running in the development
run mode.
apiServer:
port: 8080
publicHost: localhost
publicPort: 8080
publicScheme: http
insightsServer:
port: 8081
publicHost: localhost
publicPort: 8081
publicScheme: http
webServer:
port: 8082
publicHost: localhost
publicPort: 8082
publicScheme: http
database:
host: localhost
port: 8090
name: database_name
user: postgres
redis:
enabled: false
host: localhost
port: 8091
maxRequestSize: 524288
sessionLogs:
persistentEnabled: true
consoleEnabled: true