Deployments

​

Overview

A deployment is the process in which your code is downloaded from your source control provider on to your server, ready for the world to access. Forge tracks the latest 10 deployments so that you can see what was deployed, when it was deployed, how long it took to be deployed, and also view the output of your deploy script.

​

Environments

Some applications, such as those created with the Laravel framework, may require a .env file to configure settings such as databases and caches. You can create and edit your Environment file within the Forge site’s management dashboard.

​

Environment Circle Permission

You may grant a circle member authority to view and edit a site’s environment file (or WordPress configuration) using the site:manage-environment permission. Without this permission, Forge will not display the contents of the environment file to circle members.

​

Encrypted Environment Files

Forge provides support for Laravel’s encrypted environment files without requiring you to include your encryption key within your deployment script.

To leverage this feature, add your encryption key to the “Environment Encryption Key” section of your site’s management dashboard. Once added, Forge will inject the value into the LARAVEL_ENV_ENCRYPTION_KEY environment variable during deployment, allowing you to add the env:decrypt Artisan command to your deployment script without explicitly setting the --key option:

php artisan env:decrypt --force

​

Quick Deploy

Forge’s “Quick Deploy” feature allows you to easily deploy your projects when you push to your source control provider. When you push to your configured quick deploy branch, Forge will pull your latest code from source control and run your application’s configured deployment script.

You can enable Forge’s quick deploy feature by clicking the “Enable Quick Deploy” button within the Apps tab of your site’s management dashboard.

For sites using a custom source control provider you will need to manually set up a Deployment Trigger to have your code deployed when you push to your source provider. Click the “Manage Quick Deploy” button within the Apps tab of your site’s management dashboard for instructions.

​

Deploy Script

The commands that are executed on your server when your project is deployed are determined by your site’s deployment script. Of course, this deployment script can be edited directly within the Forge UI. By default, your site’s deployment script will:

• Navigate into the site’s directory
• Execute the git pull command
• Installs your application’s Composer dependencies
• Execute the php artisan migrate command (if your application contains an artisan file)

You can make your .env variables available to your deploy script by checking the “Make .env variables to deploy script” checkbox below the Deploy Script panel. When enabled, Forge will automatically inject the variables in your site’s .env file into the deploy script, allowing them to be accessed like any normal Bash variable:

echo "${APP_NAME} is deploying..."

​

PHP Versions

If you have installed multiple versions of PHP on your server, your deploy script may need to be updated to use the correct version of PHP.

By default, php will always point to the active version of PHP used on the CLI. If you need to use a different version of PHP, you must use phpx.x where x.x reflects on the version used (e.g. php8.1) when invoking PHP commands.

The deployment script for newly created sites uses the $FORGE_PHP environment variable. This environment variable will always contain the current PHP binary configured for the site, so no additional changes are needed to your deployment script when using this variable and switching your site’s PHP version.

​

Environment Variables

Forge will automatically inject the following environment variables into your deployment script at runtime:

You may use these variables as you would any other Bash variable:

if [[ $FORGE_MANUAL_DEPLOY -eq 1 ]]; then
    echo "This deploy was triggered manually."
fi

For example, you may wish to prevent deployments if the commit message contains “wip”:

if [[ $FORGE_DEPLOY_MESSAGE =~ "wip" ]]; then
    echo "WORK IN PROGRESS, DO NOT CONTINUE."
    exit 1
fi

​

Deploying From CI

So far, we have discussed deploying Forge sites from the Forge UI or by using Forge’s “Quick Deploy” feature. However, you may also deploy them from a CI platform of your choice.

To execute a Forge deployment from a CI platform, you may use Deployment Triggers or Forge CLI.

​

Using Deployment Triggers

You may execute a deployment at any time by instructing your CI platform to make a GET or POST request to the “Deployment Trigger URL” displayed in your site’s details.

Although you can refresh the site token at any time, you will need to update any services which are using this URL after refreshing the token.

Additional data may be passed to your deployment script via query parameters passed to the deployment trigger URL. For example, when passing the following query parameters ?token=abc1234&env=staging, Forge will automatically inject a custom FORGE_VAR_ENV variable that will evaluate to "staging".

There are 4 reserved parameters you may use to pass Forge information when triggering a deployment:

• forge_deploy_branch: The branch that contains the commit. Forge will only trigger a deployment if the branch matches the site’s currently deployed branch.
• forge_deploy_commit: The hash of the commit. This will be visible in the “Deployments” table and be available as the FORGE_DEPLOY_COMMIT environment variable in your deploy script.
• forge_deploy_author: The author of the commit. This will be visible in the “Deployments” table and be available as the FORGE_DEPLOY_AUTHOR environment variable in your deploy script.
• forge_deploy_message: The commit message. This will be available as the FORGE_DEPLOY_MESSAGE environment variable in your deploy script.

​

Using Forge CLI

If you would like to have access to the deployment output or execute additional deployment actions such as restarting services, you may use Forge CLI.

Once you have installed Forge CLI, you may execute the forge deploy command in your CI platform’s deployment pipeline.

In order to authenticate with Forge from your CI platform, you will need to add a FORGE_API_TOKEN environment variable to your CI build environment. You may generate an API token in your Forge API settings dashboard. In addition, your CI platform will need SSH Access to your server.

​

Example With GitHub Actions

If your site uses GitHub Actions as its CI platform, the following guidelines will assist you in configuring Forge deployments so that your application is automatically deployed when someone pushes a commit to the main branch:

1. First, add the FORGE_API_TOKEN environment variable to your “GitHub > Project Settings > Secrets” settings so that GitHub can authenticate with Forge while running actions.

2. Next, add the SSH_PRIVATE_KEY environment variable to your “GitHub > Project Settings > Secrets” settings so that GitHub can have SSH Access to your site’s server.

3. Then, create a deploy.yml file within the your-project/.github/workflows directory. The file should have the following contents:

name: Deploy

on:
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup SSH
        uses: webfactory/[email protected]
        with:
          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.1
          tools: composer:v2
          coverage: none
      - name: Require Forge CLI
        run: composer global require laravel/forge-cli
      - name: Deploy Site
        run: |
          forge server:switch your-server-name
          forge deploy your-site-name.com
        env:
          FORGE_API_TOKEN: ${{ secrets.FORGE_API_TOKEN }}

4. Finally, you can edit the deploy.yml file to fit your site’s deployment needs, as it may require a different PHP version or a library like npm. Once you are done, commit and push the deploy.yml file to the main branch so GitHub Actions can run the first deployment job.

​

Example With Chipper CI

If your site uses Chipper CI as its CI platform, the following configuring can be used to deploy your Forge sites when pushing to the main branch:

1. First, add the FORGE_API_TOKEN environment variable to your “Project > Project Settings > Secrets” settings so that Chipper can authenticate with Forge.

2. Next, add the SSH_PRIVATE_KEY environment variable to your “Project > Project Settings > Secrets” settings so that Chipper has SSH access to your site’s server.

3. Then, edit your .chipperci.yml file. The file will look something like this:

version: 1

environment:
  php: 8.1
  node: 14

on:
  push:
    branches:
      - main

# Add the following 2 pipeline steps to your Chipper CI pipeline:
pipeline:  
  - name: Configure Forge
    cmd: |
      echo $SSH_PRIVATE_KEY > ~/.ssh/id_forge
      chmod 0600 ~/.ssh/id_forge
      composer global require laravel/forge-cli
    
  - name: Deploy
    cmd: |
      forge server:switch your-server-name
      forge deploy your-site-name.com

4. Of course, you can adjust the .chipperci.yml file further to fit your needs. Once you are done, commit and push to the main branch so Chipper CI can deploy your site.

​

Deployment Branch

You may change the branch that is deployed to your site by updating the deployment branch setting. Once you have updated the branch, you will then need to click Deploy Now to manually trigger a fresh deployment of the new branch.

​

Git Remote

Updating the Git remote from the site’s App management dashboard will update the Git remote URL on your server; however, the site will not be removed or become unavailable during the process. The updated Git remote must contain the same repository / Git history as the currently installed repository.

You should not use this function to install an entirely different project onto a site. If you would like to install an entirely different project, you should completely uninstall the existing repository using the “Uninstall Repository” button within the App dashboard.

​

Deployment Notifications

You can enable deployment notifications for your site from the site management dashboard’s Notifications tab. Forge supports several notification channels:

• Email
• Slack
• Telegram
• Discord

​

Slack

To enable Slack notifications, first enter the Channel name that you wish to send messages to, and then click Enable Slack Notifications. You will be redirected to the Slack application authorization page, where you need to click Allow.

If you wish to modify the channel that Forge messages, you should first disable Slack notifications and then re-enable them for your site.

​

Telegram

To enable Telegram notifications, open Telegram and create or select a group chat that you want Forge to send deployment notifications to. Next, you should add the Laravel Forge bot to the chat by searching for the user laravel_forge_telegram_bot. Finally, copy the /start command, provided by Forge under the Telegram Deployment Notifications section, and paste it into the chat.

If you wish to change the group that Forge messages, you should disable Telegram notifications and then follow the above steps again to reactive notifications.

​

Discord

To enable Discord notifications, you first need to create a new Incoming Webhook integration on your Discord server. Once Discord has generated a webhook, you need to copy the URL into the Webhook URL field, then click Enable Discord Notifications. Forge will now notify the configured channel for both successful and failed deployments.

If you wish to change the webhook URL, you first need to disable Discord notifications and then re-enable the notifications.

​

Webhooks

Forge can also send an HTTP POST request to arbitrary URLs after each deployment. The payload of the request will contain the server ID, site ID, deployment status, and the relevant commit information:

{
  "status": "success",
  "server": {
    "id": 123,
    "name": "my-awesome-server"
  },
  "site": {
    "id": 456,
    "name": "my-awesome-site.dev"
  },
  "commit_hash": "382b0f5185773fa0f67a8ed8056c7759",
  "commit_url": "https://github.com/johndoe/my-awesome-site/commit/382b0f5185773fa0f67a8ed8056c7759",
  "commit_author": "John Doe",
  "commit_message": "deploying!"
}

​

Circle Permissions

You may grant a circle member authority to manage deploy scripts, manage maintenance mode, and deploy a site by granting the site:manage-deploys permission.