Bedrock: a Scalingo Friendly WordPress Boilerplate
WordPress is not well suited to be directly deployed on Scalingo. They do not follow the best modern practices of web development such as 12 factor. The easiest way to get started with WordPress on Scalingo is to click on this button:
Customize Scalingo Distribution
You may need to customize a bit the above-mentioned distribution in order to add a plugin or a them for instance. In order to do that, you first need to clone the distribution:
git clone https://github.com/Scalingo/scalingo-wordpress cd scalingo-wordpress
Then, update your application environment through the dashboard or with the
Scalingo command line
scalingo env-set VARIABLE_NAME=VALUE:
DATABASE_URL: Connection string to the MySQL database -
mysql://localhost:3306/wp-bedrock- Automatically added with the Scalingo MySQL addon
WP_ENV: Set to environment (
WP_HOME: Full URL to WordPress home (https://my-wordpress.osc-fr1.scalingo.io)
WP_SITEURL: Full URL to WordPress including subdirectory (https://my-wordpress.osc-fr1.scalingo.io/wp)
S3_UPLOADS_BUCKET: Name of the S3 bucket to upload files to
S3_UPLOADS_KEY: AWS Access Key ID for S3 authentication
S3_UPLOADS_SECRET: AWS Secret Key for S3 authentication
S3_UPLOADS_REGION: Region of the S3 bucket
You can get some random salts on the Roots WordPress Salt Generator.
Add themes in
web/app/themesas you would for a normal WordPress site.
Deploy the application on Scalingo
# Optionally add theme to your git repository git add web/app/themes git commit -m "Add themes" # Then push to Scalingo git push scalingo master
- Access WP admin at
When a PHP application is deployed, we’re looking if the
is present at the root folder of your app.
During the deployment process you’ll see the following output, mentioning that the framework has correctly been detected.
-----> Detected WordPress ... -----> Setting up WordPress
Deploying Pure WordPress on Scalingo
Even though it is not advised to deploy an out-of-the-box WordPress on Scalingo, there are some situations where you do not have the choice. Here are a few things you must now before going down that road.
By default WordPress uses a configuration file to configure a deployed
application. In order to add environment variables support, you must edit the
wp-config.php file to read the
DATABASE_URL environment variable.
This can be done by adding those lines:
$mysql_url = parse_url($_ENV["DATABASE_URL"]); $db = substr($mysql_url['path'], 1);
And changing the
DB_* definitions to:
define('DB_NAME', $db); define('DB_USER', $mysql_url['user']); define('DB_PASSWORD', $mysql_url['pass']); define('DB_HOST', $mysql_url['host'] . ":" . $mysql_url['port']);
You must do the same things for all your salts and keys. We recommend using a
common environment variable and set it to a random string. You must adapt your
wp-config.php to use this variable:
$key = $_ENV["SECURE_KEY"]; define('AUTH_KEY', $key); define('SECURE_AUTH_KEY', $key); define('LOGGED_IN_KEY', $key); define('NONCE_KEY', $key); define('AUTH_SALT', $key); define('SECURE_AUTH_SALT', $key); define('LOGGED_IN_SALT', $key); define('NONCE_SALT', $key);
The only thing left is to define the
SECURE_KEY from the dashboard or by
using our CLI:
scalingo -a myapp env-set SECURE_KEY=A_RANDOM_TOKEN_HERE
By default, WordPress tries to detect if the website is reached with HTTPS. However in an environment like Scalingo, applications are behind a routing layer which acts as proxy, which prevent WordPress to correctly detect the use of HTTPS.
To fix this problem, you need to add the following in your
if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https') $_SERVER['HTTPS'] = 'on';
Thanks to this snippet, WordPress will look at the HTTP header
X-Forwarded-Proto set by our router to ‘http’ or ‘https’ whether the website
is accessed with HTTP or HTTPS. Have a look at our routing
documentation for more
information about this header.
Plugins and Updates
Since the container file system is volatile, plugins and addon should be installed and updated within your Git repository and never via the web interface. You must de-activate auto-update of all your WordPress components.
To do that add the following line to your
define( 'AUTOMATIC_UPDATER_DISABLED', true );
TLS Connection to MySQL
If you configured your MySQL with Force TLS, it is mandatory
that your application connects to the database using TLS. With WordPress, you
need to add the following line in your
The container file system is volatile and not synchronized through all your instances. So the uploads should not be stored on the file system itself. We recommend using an external service like the Amazon service: AWS S3 to store them.
You may want to have a look at a plugin such as S3 Uploads to ease the storage of your uploads on S3. As usual, this plugin must be downloaded locally and pushed to our Git repository, never via the web interface.