servd

Log into your domain registrar, or wherever your DNS records are managed from.

Update your relevant domain record TTLs to the lowest value possible.

Push your codebase to a git repository (preferably one on GitHub, GitLab or Bitbucket).

Sign up for a Servd account or log in if you already have one.

Create a new Project.

Authenticate with your repository provider when asked, and select the repository you would like to use.

Optionally add your node build command (see below for more detail).

Complete the remainder of the project creation flow.

First you'll need an SQL dump file of your existing database. These usually have a file extension of .sql, or if they're compressed, .sql.gz or .sql.zip. It's usually a good idea to export them to a compressed format to speed things up later.

Navigate to your staging import page and upload your SQL dump via the "Import Database Dump" upload form. As there's currently nothing in the staging database, you can leave the "Erase all tables before import" checkbox empty. This will upload the file to Servd and begin the import into your staging database.

Wait for the database import to complete. It can take a few minutes to complete depending on how large your existing database is; having a compressed dump file will help speed up the upload part.

You can see the import's current status in the task bar at the bottom of the page. Once you see a ✅ you're done!

Install a file transfer tool that supports S3 connections. Popular ones include Cyberduck, Transmit, s3cmd, AWS CLI, and rclone (our current favourite)

Go to your project's asset settings, and click the "Generate New Access Key" button to create a set of access credentials to the Servd CDN.

Connect to the Servd CDN. Here are a few tool-specific guides:

• Manage Assets Using Cyberduck
• Manage Assets Using Transmit
  
• Manage Assets Using s3cmd
  
• Manage Assets Using AWS CLI
• Manage Assets Using rclone

Before we start uploading our assets, it's worth taking note of a few things:

• There are local, staging and production directories already present on the CDN. These correspond to the different environments of your project.
• It's important to keep the directory structure of your assets the same as your old volume. This will avoid having to re-index all your assets, which can take a long time for remote volumes.
• If you are uploading assets from multiple volumes, you'll need to supply a "subfolder" for each volume's settings page. Otherwise your files will all get mixed up in the same directory.
• Your project has an asset storage limit, which all your environments share. Visit your project's plan page to track your current usage. What happens if I exceed the asset storage limit?

Use your file transfer tool of choice to upload your assets into the staging/ directory. This might take a few minutes, so let's carry on to the next step. 👇

Get your project's local development environment up and running on your machine.

Don't have one yet? We recommend DDEV.

On your local build, install the Servd plugin via composer CLI:

composer require servd/craft-asset-storage

You should see your composer.json and composer.lock files update.

Run the following to enable the Servd plugin:

./craft plugin/install servd-asset-storage

Or alternatively, navigate to your local Craft plugin settings page and enable the Servd plugin.

Either way should update your project config files.

Using the details from your project's asset settings, add the following to your .env file:

SERVD_PROJECT_SLUG=<your project slug>
SERVD_SECURITY_KEY=<your project security key>

For Craft 3

In your local control panel, navigate to Settings > Assets. For each local asset volume:

1. Click the volume from the list.
2. Select "Servd Asset Storage" from the Volume Type dropdown.
3. Click Save.

For Craft 4

In your local control panel, navigate to Settings > Filesystems.For each local asset volume:

1. Click the filesystem from the list.
2. Select "Servd Asset Storage" from the Filesystem Type dropdown.
3. Click Save.
   

In Craft 4 you also have the option to continue using the local filesystem whilst in local dev. Check out the Servd Plugin Documentation for more info.

This will tell Craft to start looking for assets on the Servd CDN, instead of in your local web directory. Your assets will now stop rendering when you view them in the browser, this is because we've not yet uploaded them to the Servd CDN.

Commit all composer and project config file changes and push them to your git repository.

Navigate to your project's staging settings. Create a new bundle using the commit you just made, sync it to staging and wait for the deploy to finish.

Once the assets have finished uploading, visit your project's staging URL and the assets should magically appear. ✨

Add billing details to your team.

Alternatively, if your client is going to be responsible for billing, you can invite them to create a Servd team and they can add billing details themselves. Once that's complete, you just need to transfer the project over to their team.

Select a subscription plan to unlock the project's production environment.

Navigate to the production import page.

In the "Clone From Environment" section, trigger a clone from staging to import the database, assets, selected bundle and new environment variables.

This will take everything that's in your staging environment and copy it over to production. Depending on how many assets you have and how big your database is, this will likely take a few minutes to complete. Plenty of time to make a coffee. ☕️

Once the clone task completes, you'll probably want to check over your environment variables in the production settings page to make sure anything staging-specific is updated for production. Remember to sync if anything needs changing.

Navigate to your project's domains page. Follow these instructions to add and activate your primary domains for the project.

Note: doing this step won't trigger requests going to the domain to start going to Servd, that will come later when you switch your DNS records. This change means that any requests to the domain that Servd receives will be routed to your project.

Now is a good time to explore some of the optional features Servd provides that will make your site a lot quicker and more resilient:

• Static Caching - enabling static caching can dramatically improve the performance of your site by avoiding unnecessary calls to the database.
• Rate Limiting - rate limiting is enabled by default, but you may want to check whether you're happy with the level it's set to.

You should now be ready to review your production site and make sure there aren't any issues before going live.

Review your production environment variables again on your production settings page. You'll likely want to update any URLs that were using your project's servd.dev subdomain to your production domain. Sync your project to deploy any changes.

Update your primary domain DNS records as per the "DNS" steps in your project's domains page. This will begin moving traffic from your previous host to Servd.

If everything appears to be working, increase your DNS record TTLs again to improve the availability and resolution speed of your domain.

You're officially now on Servd! 🙌

If you found this process nice and easy, share the love with the Craft community on Discord and Twitter. Every kind words helps us out a lot.

If you found it a little tricky, or you found gaps in this guide, please get in touch over our support! We're always on the lookout for ways to make things easier.