Skip to main content

Upgrade to .env Variables

Introduction​

Starting from January 6 2026, Sunrise has transitioned to using .env files for configuration management.

In this guide, we will walk you through the steps to migrate the environment data from the existing appsettings.*.json files to the new .env format.

info

This upgrade is only focused for people who are self-hosting Sunrise server without Solar System orchestration and plan to continue self-hosting after the upgrade.

If you are planning to migrate to Solar System orchestration, the following upgrade guide is not applicable for you, as Solar System uses its own configuration management system.

Upgrading​

tip

This is not a requirement, but it is highly recommended to back up your existing configuration files and database before proceeding with the upgrade.

To do so, run !backupdatabase Bancho command in-game to back up your database. After it's done, continue with this guide.

  1. Stop the Server: Ensure that your Sunrise server is not running before making any changes.

If you are running the server using Docker Compose:

docker compose -f docker-compose.yml down

Or manually stop the server if you are running it directly.

  1. Create a .env File: In the root directory of your Sunrise server, there should be a file named .env.example. Create a copy of this file and rename it to .env.

On Linux or macOS, you can use the following command:

cp .env.example .env

On Windows, you can use:

copy .env.example .env
  1. Migrate Configuration Values: Open your existing appsettings.*.json files and copy the relevant configuration values to the corresponding variables in the .env file.

Here is an example mapping of the values from appsettings.json to .env variables:

warning

Please notice that Hangfire.ConnectionString is deprecated and doesn't need to be migrated to .env file any more. Use the same connection string as Database.ConnectionString instead.

  1. Save Changes: After migrating all the necessary values, save the .env file.

  2. Restart the Server: Start your Sunrise server again to apply the changes.

If you are using Docker Compose:

docker compose -f docker-compose.yml up -d --build --remove-orphans

Or start the server manually if you are running it directly.

Common problems​

env file C:\Sunrise\.env not found: CreateFile C:\Sunrise\.env: The system cannot find the file specified.​

This error indicates that the .env file is missing from the root directory of your Sunrise server. Please refer to step 2 of the upgrading process to create the .env file.

MySql.Data.MySqlClient.MySqlException (0x80004005): Unable to connect to any of the specified MySQL hosts​

This error indicates that the server is unable to connect to one of the MySQL hosts.

If the error code includes Hangfire mention:​

This indicates that you probably copied the Hangfire.ConnectionString value from appsettings.json to .env file.

As mentioned in step 3 of the upgrading process, Hangfire.ConnectionString is deprecated and doesn't need to be migrated any more. Use the same connection string as Database.ConnectionString instead.

If the error code doesn't include Hangfire mention:​

Please double-check the Database.ConnectionString value in your .env file to ensure it is correct and matches your database configuration.

Make sure that the database server is running and accessible from the machine where the Sunrise server is hosted.

Deprecated hangfire connection was using Postgres, which is no longer supported. Please set up Hangfire connection using environment variables.​

This error indicates that you didn't set HANGFIRE_ prefixed environment variables in your .env file and your previous Hangfire connection was using Postgres.

Please add HANGFIRE_ prefixed environment variables to your .env file following step 3 of the upgrading process.