Notes

# Development Environment Setup

The development environment uses Apache and Docker. The application lives in
Docker. We will amke requests to `https://fs247.kandrsoft.dev` and those
requests are handle by Apache and proxied to Docker. They are also HTTPS
requests so SSL needs to be enabled.

Additionally, we use [Mailcatcher](https://mailcatcher.me/) in the `development` and
`staging` environments. You will need to install Mailcatcher locally for
development (covered later).

The commands below are written in such a way that thye can be copy-pasted to
your terminal for quickly setting up your dev environment.

## Apache Setup

### Installation

You will need Apache installed:

```bash
sudo apt update && sudo apt install -y apache2
```

### Configuration

Enabled the required Apache modules:

```bash
sudo a2enmod
actions
deflate
env
filter
headers
proxy
proxy_http
request
rewrite
ssl
substitute
```

## Docker Setup

### Installation

Ref: https://wiki.perceivers.net/Docker

```bash
sudo apt-get remove docker docker-engine docker.io;
sudo apt-get update;
sudo apt-get install -y
apt-transport-https
ca-certificates
curl
software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null <<EOF
deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable
# deb-src [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable
EOF
sudo apt update;
sudo apt install docker-ce docker-ce-cli containerd.io;
sudo usermod -a -G docker $USER
mkdir -p /home/"$USER"/.docker
sudo chown -R "$USER":"$USER" /home/"$USER"/.docker
sudo chmod -R g+rwx "/home/$USER/.docker"
sudo systemctl enable docker
newgrp docker
sudo curl -L https://github.com/docker/compose/releases/download/1.29.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose;
sudo chmod +x /usr/local/bin/docker-compose;
```

## The FS 24/7 Dispatching Application Setup

### Virtual Host for this FS 24/7 application

* Symlink the project files to the standard location for a webapp:

```bash
sudo ln -s `pwd` /srv/http/fs247.kandrsoft.dev
```

* Ensure that the log directory and `development.log` file exists for the app:

```bash
mkdir -p /srv/http/fs247.kandrsoft.dev/log
touch /srv/http/fs247.kandrsoft.dev/log/{development,migrations}.log
chmod a+w /srv/http/fs247.kandrsoft.dev/log/*.log
```

* Symlink the Apache virtual host configuration for Apache from this repository
to the configuraiton for your development machine:

```bash
sudo ln -s `pwd`/config/apache/fs247.kandrsoft.dev.conf /etc/apache2/sites-available/
```

* Symlink the SSL files into place on your local development machine

```bash
sudo ln -s `pwd`/config/ssl/_.kandrsoft.dev.crt /etc/ssl/certs/
sudo ln -s `pwd`/config/ssl/_.kandrsoft.dev.key /etc/ssl/private/
```

* Enable this virtual host configuration:

```bash
sudo a2ensite fs247.kandrsoft.dev.conf
```

You will need a local `.env` file and `settings.local.php` file. You can start
with the examples:

```bash
cp ./.env{.example,}
cp ./config/settings.local{.example,}.php
```

### Starting the application

The services needed by the application (MySQL, Mailcatcher, etc) are provided by
"sidecar" Docker containers ("Sidecar" containers are separate containers that
run alongside your mail application's container to provide additional services
to your application).

You can start all the required containers using Docker Compose (installed
earlier with Docker).

```bash
docker-compose up
```

The DNS services are unaware of the names generated for your new Docker
containers. We will need entries in your `/etc/hosts` file for these names.
Synching these names to the `hosts` file can be done manually or with the
`whales-names` package. If you want to use `whales-names`, just install it:


```bash
npm install -g whales-names
```

...then run it in its own console tab:


```bash
whales-names
```