How to create a new test site

• Step 1: Create a DNS record
• Step 2: Create a site on the staging server
  • Create a site on the load balancer server
  • WIP
  • Update environment file
  • Deploy
  • Update environment file for deployed site
  • Update nginx configuration
  • Update config cache and restart services
  • Optional: Update CI/CD to enable auto-deploy
  • Setup DB
  • Download GeoDB

Step 1: Create a DNS record

• Go to CloudFlare for ixdf.dev’s DNS Records
• Create A DNS record ("Add record") for the new subdomain (similar to the feature.ixdf.dev):
  • Name: e.g. staging for the feature.ixdf.dev
  • IPv4 address: load balancer's public (reserved) IP address
  • Proxy status: DNS only

Step 2: Create a site on the staging server

1. Go to staging-web server configuration on Laravel Forge:

2. Fill out and submit the "New Site" form:

   • Custom Domain: Enter full name domain
   • Web directory (from advanced settings): /current/public
   • Other inputs: Leave defaults

   

Create a site on the load balancer server

Add site on load balancer

Obtain an SSL certificate

• Click on "SSL" under "Site Details" on new site’s Laravel Forge page. Choose "LetsEncrypt" and then "Obtain Certificate":

WIP

On example of staging env for the staging.ixdf.dev domain:

1. Add a new server to the `deploy.php` file (similar to the `staging.ixdf.dev`, but customize `env_name`)
1. Update nginx configuration
1. Create and push `.env.{env_name}.encrypted` file (use unencrypted `.env.staging.encrypted` as an example)
   1. make sure REDIS_DB and REDIS_CACHE_DB have unique values (requires checking other env files)
   1. get encrypt key from the staging server: `./deployer.phar env:encrypt-key:show staging`
   1. use it to encrypt `env.feature`: `php artisan env:encrypt --force --env feature --key {{key}}`
   1. commit and push encrypted file to the github (required on the `deploy` step)
1. Deploy:
   1. Remove `~/feature.ixdf.org/current` directory (it's created by Forge, but Deployer wants to create it itself)
    ```shell
    rm -rf ~/feature.ixdf.dev/current
    ```

   1. Run `./deployer.phar deploy {env_name}` to deploy the new site
   1. Check app works by the new address
1. Create Slack channels:
   1. `errors--{env_name}`
   1. `cron--{env_name}`
1. Add `php ~/feature.ixdf.dev/current/artisan schedule:run -vvv` [to cron](https://forge.laravel.com/servers/795724/scheduler) (every minute)
1. Setup supervisor for Horizon
   1. Create a supervisor config for Horizon for the new server and put it to the `infrastructure/supervisor/{env_name}/conf.d/` directory:
      1. copy [horizon--staging.conf](https://github.com/InteractionDesignFoundation/IxDF-web/blob/main/infrastructure/supervisor/staging/conf.d/horizon--staging.conf)
      1. find and replace `staging` with the new server name (aka `{env_name}`)
   1. Run `./deployer.phar site:setup:supervisor-for-horizon {env_name}` task

Update environment file

• Go to feature.ixdf.dev’s environment configuration on Laravel Forge
• Copy the environment variables and paste it into new site’s environment file.
• Remember to change these variables based on your domain name:
  1. APP_ENV
  2. APP_URL
  3. DB_DATABASE

Deploy

• Add a new host to deploy.php. Run deployment by dep deploy {newhost}. If deployment fails dur to inspections, please fix them or (if it's not possible) comment out artisan:server:audit task from deploy the task pipeline.

Update environment file for deployed site

• Go to https://feature.ixdf.dev's environment configuration on Laravel Forge: https://forge.laravel.com/servers/32540/sites/66422#/environment
• Copy the environment variables and paste it into new site’s environment file.
• Remember to change these variables based on your domain name:1. APP_ENV2. APP_URL3. DB_DATABASE

Update nginx configuration

• Scroll down to the bottom and click on "Files > Edit nginx Configuration". Open infrastructure/nginx/site-template.nginx.jinja2 file, replaces vars from this file by values and paste content to Forge editor. Save changes.

Update config cache and restart services

• After any change in the.env file, you need to run these deployer tasks:

1. config-changed
2. services:restart

Optional: Update CI/CD to enable auto-deploy

• Copy "Deploy Script" from develop site and paste it to new site’s "Deploy Script". Remember to update GIT_BRANCH other variables from the very top section. Click on "Save Script".
• Add a new host to deploy.php and run a deployment for the new site.

Setup DB

Run composer db:update to use develop dump.

Download GeoDB

php artisan geo:database:update