Merge pull request #57 from silinternational/release/1.11.0

Release 1.11.0 - AppConfig

.github/workflows/test-and-publish.yml

@@ -33,7 +33,7 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ vars.DOCKER_ORG }}/email-service
+          images: ${{ vars.DOCKER_ORG }}/${{ github.event.repository.name }}
       - name: Build and push Docker image
         uses: docker/build-push-action@v5
         with:

Dockerfile

@@ -34,6 +34,9 @@ COPY dockerbuild/vhost.conf /etc/apache2/sites-enabled/
 # ErrorLog inside a VirtualHost block is ineffective for unknown reasons
 RUN sed -i -E 's@ErrorLog .*@ErrorLog /proc/self/fd/2@i' /etc/apache2/apache2.conf
 
+ADD https://github.com/silinternational/config-shim/releases/latest/download/config-shim.gz config-shim.gz
+RUN gzip -d config-shim.gz && chmod 755 config-shim && mv config-shim /usr/local/bin
+
 EXPOSE 80
 
 CMD ["/data/run.sh"]

README.md

@@ -11,6 +11,26 @@ Simple service to queue and send emails
 2. `make`
 3. Upon successful initialization, the API will be available locally at `http://localhost:8080/email`
 
+## Configuration
+By default, configuration is read from environment variables. These are documented
+in the `local.env.dist` file. Optionally, you can define configuration in AWS AppConfig.
+To do this, set the following environment variables to point to the configuration in
+AWS:
+
+* `AWS_REGION` - the AWS region in use
+* `APP_ID` - the application ID or name
+* `CONFIG_ID` - the configuration profile ID or name
+* `ENV_ID` - the environment ID or name
+
+In addition, the AWS API requires authentication. It is best to use an access role
+such as an [ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html).
+If that is not an option, you can specify an access token using the `AWS_ACCESS_KEY_ID` and
+`AWS_SECRET_ACCESS_KEY` variables.
+
+The content of the configuration profile takes the form of a typical .env file, using
+`#` for comments and `=` for variable assignment. Any variables read from AppConfig
+will overwrite variables set in the execution environment.
+
 ## API
 See [api.raml](api.raml) for API docs.
 

application/common/config/main.php

@@ -15,7 +15,7 @@
 $mysqlDatabase     = Env::requireEnv('MYSQL_DATABASE');
 $mysqlUser         = Env::requireEnv('MYSQL_USER');
 $mysqlPassword     = Env::requireEnv('MYSQL_PASSWORD');
-$notificationEmail = Env::requireEnv('NOTIFICATION_EMAIL');
+$notificationEmail = Env::get('NOTIFICATION_EMAIL');
 
 $emailQueueBatchSize = Env::get('EMAIL_QUEUE_BATCH_SIZE', 10);
 $mailerUseFiles      = Env::get('MAILER_USEFILES', false);
@@ -71,6 +71,7 @@
                     'exportInterval' => 1,
                 ],
                 [
+                    'enabled' => !empty($notificationEmail),
                     'class' => EmailTarget::class,
                     'except' => [
                         'yii\web\HttpException:400',

application/composer.json

@@ -8,7 +8,7 @@
     }
   ],
   "require": {
-    "php": ">=7.0",
+    "php": ">=8.1",
     "ext-json":"*",
     "aws/aws-sdk-php": "^3.136",
     "fillup/fake-bower-assets": "2.0.9",