Skip to content

Commit bc8d55b

Browse files
committed
protected files in example
Update README to reflect protected files in the example
1 parent d655263 commit bc8d55b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,21 @@ See the example below
198198
nginx-certificates: '[{"certificateName": "$NGINX_CERT_NAME", "keyvaultSecret": "https://$NGINX_VAULT_NAME.vault.azure.net/secrets/$NGINX_CERT_NAME", "certificateVirtualPath": "/etc/nginx/ssl/my-cert.crt", "keyVirtualPath": "/etc/nginx/ssl/my-cert.key" } ]'
199199
debug: false
200200
```
201+
202+
## Handling Protected files in the configuration
203+
For files that contain any sensitive data, you can mark them as protected. You cannot access the file contents of a protected file saved to the NGINX configuration, but you can view its metadata. The input for protected files takes a comma-separated list of file paths relative to nginx-config-directory-path that should be marked as protected.
204+
205+
```yaml
206+
- name: "Sync NGINX configuration- mark protected files in NGINXaaS for Azure"
207+
uses: nginxinc/nginx-for-azure-deploy-action@v0.5.0
208+
with:
209+
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
210+
resource-group-name: ${{ secrets.AZURE_RESOURCE_GROUP_NAME }}
211+
nginx-deployment-name: ${{ secrets.NGINX_DEPLOYMENT_NAME }}
212+
nginx-deployment-location: ${{ secrets.NGINX_DEPLOYMENT_LOCATION }}
213+
nginx-config-directory-path: config/
214+
nginx-root-config-file: nginx.conf
215+
transformed-nginx-config-directory-path: /etc/nginx/
216+
protected-files: 'servers/server1.conf,conf.d/sensitive.conf'
217+
debug: false
218+
```

0 commit comments

Comments
 (0)