Envoyer ​

Overview ​

Forge now offers zero downtime deployments, thanks to a seamless first-party integration with Envoyer. Envoyer's zero downtime deployments ensure you avoid even those brief milliseconds of downtime while the server updates your code.

Creating An Envoyer API Token ​

To kick things off, you'll need active subscriptions for both Laravel Forge and Envoyer. Once you’re set up, navigate to your Envoyer dashboard and create a new API token. At a minimum, Forge requires the following scopes:

deployments:create
projects:create
servers:create

Linking Your Envoyer Account To Forge ​

Next, it’s time to link Forge with your Envoyer API token. Navigate to your account settings in Forge and click on the Envoyer navigation item.

Creating New Sites With Envoyer ​

When creating a new site in Forge, you’ll notice a new option labeled “Configure with Envoyer”. Toggle this option to reveal a dropdown menu, where you can either select an existing Envoyer project or create a brand new one.

Envoyer Sites In Forge ​

To deploy your Envoyer project within Forge, simply click the “Deploy Now” button, just as you would with any other site in Forge. The “Deployment Trigger URL” is also available for use in a CI environment.

Additionally, Forge has been updated to align perfectly with Envoyer projects:

• Commands are executed from the /current directory.
• The Environment panel will display a read-only version of the .env file. Continue to use Envoyer to manage your environment file, especially since it may need to be synchronized across multiple servers.
• The site’s Packages panel is disabled to ensure the auth.json file remains intact through subsequent deployments.

Migrating An Existing Site To Envoyer ​

Before migrating your Forge site to Envoyer, ensure your site directory does not contain a directory named releases or current. This is essential in allowing Envoyer to create these directories during the project's installation on your server.

Next, access the Envoyer dashboard and navigate to the relevant project. Within the project settings, select "Import Forge Server", then choose the appropriate server and site before clicking "Import Server."

After adding the server details, it's crucial to test the connection to ensure that Envoyer can communicate with your server effectively. You can test the connection status from the server overview.

Next, click the "Manage Environment" button, unlock your environment, and sync it to the new server. This action will replace the contents of the existing .env file in the site directory on the server.

Now, you should initiate a deployment from Envoyer. Once the deployment is complete, Envoyer will download the latest version of your application into the releases directory of your site and add a symlink to /current.

Your site should still be accessible, but the old version is still being served. To address this, navigate to the "Settings" panel in Forge and prefix the web directory with /current. For example, if your site's web directory is currently /public, update it to /current/public. Doing so will instruct Nginx to serve your application from /home/forge/example.com/current/public – the location where Envoyer has installed the latest version of your application.

You should now tidy your site directory by ensuring it only contains the .env file, along with the releases, current, and storage directories. After ensuring you have backed up anything you need, you may remove everything else, including any dotfiles and directories such as .git, .gitattributes, etc.

Now that the web directory includes /current, Forge will recognize your site as being managed by Envoyer in the "Envoyer" panel. You can now link Forge and Envoyer together by selecting the relevant project from the project list.

Finally, now that your application is being served from the /current directory, you should update your scheduler, queue workers, and any daemons to ensure they are running from the correct path.