You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+73-5Lines changed: 73 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# NGINX for Azure Deployment Action
2
2
3
-
This action supports managing the configuration of an [NGINX for Azure](https://docs.nginx.com/nginx-for-azure/quickstart/overview/) deployment in a GitHub repository. It enables continuous deployment through GitHub workflows to automatically update the NGINX for Azure deployment when changes are made to the NGINX configuration files stored in the respository.
3
+
This action supports managing the configuration of an [NGINX for Azure](https://docs.nginx.com/nginx-for-azure/quickstart/overview/) deployment in a GitHub repository. It enables continuous deployment through GitHub workflows to automatically update the NGINX for Azure deployment when changes are made to the NGINX configuration files stored in the respository. Additionally, one can update NGINX certificates that are already present in Azure key vault.
4
4
5
5
## Connecting to Azure
6
6
@@ -34,7 +34,7 @@ jobs:
34
34
creds: ${{ secrets.AZURE_CREDENTIALS }}
35
35
36
36
- name: 'Sync the NGINX configuration from the GitHub repository to the NGINX for Azure deployment'
To facilitate the migration of the existing NGINX configuration, NGINX for Azure supports multiple-files configuration with each file uniquely identified by a file path, just like how NGINX configuration files are created and used in a self-hosting machine. An NGINX configuration file can include another file using the [include directive](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/). The file path used in an `include` directive can either be an absolute path or a relative path to the [prefix path](https://www.nginx.com/resources/wiki/start/topics/tutorials/installoptions/).
@@ -100,7 +143,7 @@ To use this action to sync the configuration files from this example, the direct
100
143
101
144
```yaml
102
145
- name: 'Sync the NGINX configuration from the GitHub repository to the NGINX for Azure deployment'
Since certificates are secrets, it is assumed they are stored in Azure key vault. One can provide multiple certificate entries to the github action as an array of JSON objects with keys:
197
+
198
+
`certificateName`- A unique name for the certificate entry
199
+
200
+
`keyvaultSecret`- The secret ID for the certificate on Azure key vault
201
+
202
+
`certificateVirtualPath`- This path must match one or more ssl_certificate directive file arguments in your Nginx configuration; and must be unique between certificates within the same deployment
203
+
204
+
`keyVirtualPath`- This path must match one or more ssl_certificate_key directive file arguments in your Nginx configuration; and must be unique between certificates within the same deployment
205
+
206
+
See the example below
207
+
208
+
```yaml
209
+
- name: "Sync NGINX certificates to NGINX for Azure"
0 commit comments