in your web browser and being your local upgrade review.
{% hint style="success" %}
At this point, providing you're satisfied with your local testing, we would recommend that you push your changes to your `origin` remote.
{% endhint %}
### Part 4: Updating Deployment Strategy
{% hint style="info" %}
Elentra ME 1.22 requires Deployer v6.8.0 in order to support the new requirement of a local build step for Elentra JS 2. If you already have Deployer configured, you can skip this step.
The full Elentra Deployment Tool documentation is available from within the [Elentra Deployment documentation](https://docs.elentra.org/technical/developers/elentra-deployment) section.
{% endhint %}
{% hint style="warning" %}
The following transition instructions are to be used as reference-only, as there may be unique circumstances within your existing deployment recipe to be considered.
{% endhint %}
#### **Step 1: Copy Deployer template files into your Branded Edition repository**
Download the raw `.deployignore` and `deploy.php` files from the [Elentra Developer GitHub Repository](https://github.com/ElentraProject/elentra-developer/tree/master/resources/templates/deployer/v6) and place them in your `~/Sites/uni-elentra-1x-me/deployment` directory
#### Step 2: Update the values in the Deployer recipe template
Open the Deployer ("Dep") `deployment/deploy.php` deployment recipes in your editor or IDE. There are a few variables at the top of `deploy.php` that need to be set. The following table describes variable names that must set.
| Variable Name | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `application` | Application Name (e.g., `uni-elentra-1x-me`) |
| `packagist_token` | Institutional Packagist.com Composer token |
| `repository` | Branded Edition Elentra ME Git repository location |
| `branch` | The default deployment branch (e.g., `master`) within your Branded Edition Elentra ME Git repository. This value is always overridden by the host configuration section (if present), so it not overly important. |
| `repository_ejs` | Default recommended.
This can be left as-is unless you have a Branded Edition Elentra JS Git repository.
|
| `branch_ejs` | Default recommended.
This can be left as-in unless you have a Branded Edition Elentra JS Git repository. This value is always overridden by the host configuration section (if present), so it not overly important.
|
| `enable_branded_api` | Default value is false.
If you have a Branded Edition Elentra API with your implementation of Elentra then please set this to true
|
Once you have configured all of the variables correctly, the next step is to translate the hosts configuration. The following section illustrates a single staging server and multiple production server transition.
{% hint style="info" %}
For more documentation related to host configuration options, please see the [Deployer Hosts documentation](https://deployer.org/docs/6.x/hosts/), which is quite extensive.
{% endhint %}
#### Example Deployer (deploy.php) Recipe Host configuration
```
# Elentra ME
// Staging Server
host('elentra-staging.med.university.edu')
->stage('staging')
->user('staging')
->set('branch', 'uni/staging')
->set('branch_ejs', 'develop')
->set('deploy_path', '/var/www/vhosts/elentra-staging.med.university.edu')
->roles('app')
->forwardAgent();
// Production Server
host('elentra01.med.university.edu', 'elentra02.med.university.edu')
->stage('production')
->user('production')
->set('branch', 'uni/production')
->set('branch_ejs', 'master')
->set('deploy_path', '/var/www/vhosts/elentra.med.university.edu')
->roles('app')
->forwardAgent();
```
**Step 3: Review Deployment Commands**
The typical deployment commands used by institutions are referenced below, but please see the [Elentra Deployment documentation](https://app.gitbook.com/@elentra/s/technical/~/drafts/-MibaAexAhmyr9VAM3iz/developers/elentra-deployment) for a full list of all commands available.
{% hint style="success" %}
The Deployer deployment strategy transition should require no Apache configuration changes and was designed to be fully backwards compatible with older Capistrano recipes.
{% endhint %}
| Deployer | Capistrano |
| ----------------------- | ----------------------------- |
| `dep deploy staging` | `cap staging deploy` |
| `dep deploy production` | `cap production deploy` |
| `dep rollback staging` | `cap staging deploy:rollback` |
### Part 5: Testing on Staging
Providing that you have pushed the changes to your `uni/staging` branch to your `origin` remote, you can now deploy the upgrade to your staging environment from within your Docker container.
1. Log into your local `elentra-developer` Docker container, and change to your `deployment` directory:
```bash
docker exec -it elentra-developer bash
cd /var/www/vhosts/uni-elentra-1x-me/deployment
```
2. Deploy changes to your staging server using the new Deployer deployment recipe:
```bash
dep deploy staging
```
3. Providing the deployment was successful, you should now be able to visit in your web browser to begin a thorough review of your upgraded Branded Edition implementation of Elentra ME.
{% hint style="info" %}
For the most accurate review possible, we would recommend that you have a recent version of your production databases installed and scrubbed loaded on your staging database server. This is typically achieved using the `scrub.sh` shell script included with the Elentra Platform.
{% endhint %}
### Part 6: Deploy to Production
Providing that you have thoroughly tested your upgraded Branded Edition implementation of Elentra ME on within your staging environment, it is safe to proceed with a production upgrade.
1. From within Sourcetree on your developer workstation, open your existing local Elentra ME Branded Edition (i.e., `uni-elentra-1x-me`) repository.
2. Checkout your `uni/production` branch.
3. Right click on your `uni/staging` branch and click "Merge uni/staging into uni/production". This will merge all of the commits that have gone into creating the upgrade, into your `uni/production` branch.
4. Push the commits in the `uni/production` branch to your `origin` remote. Log into your local `elentra-developer` Docker container, and change to your `deployment` directory:
```bash
docker exec -it elentra-developer bash
cd /var/www/vhosts/uni-elentra-1x-me/deployment
```
5. Deploy changes to your production server using the new Deployer deployment recipe:
```bash
dep deploy production
```
6. Providing the deployment was successful, you should now be able to visit in your web browser and verify that you are now running the latest version of Elentra ME.
### Important Changes
#### Laravel Task Scheduling
The Laravel task scheduler should be configured to run on a default schedule of once every minute by adding the line following line to your crontab:
```
* * * * * php /var/www/vhosts/host.name.edu/current/www-root/core/library/vendor/elentrapackages/elentra-1x-api/artisan schedule:run >> /dev/null 2>&1
```