Update README.md

This commit is contained in:
Yuri Astrakhan 2024-05-22 23:33:59 -04:00 committed by GitHub
parent e329853d42
commit a9a33330da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 18 deletions

View File

@ -9,11 +9,27 @@ This action sets up a NGINX web server.
* On Linux, assumes it is pre-installed
* On macOS, installs using [Homebrew](https://formulae.brew.sh/formula/nginx)
* On Windows, assumes it is pre-installed
* Configures the server with the provided configuration file content (if set)
* Overrides default configuration with a simpler and more cross-platform consistent one (can be user-supplied)
* As output, provides the location of the root html dir, process ID, and access and error log files.
* [Easy to check](action.yml) that IT DOES NOT contain malicious code.
## Usage
```yaml
steps:
- uses: nyurik/action-setup-nginx@v1
id: nginx
- run: |
echo "Hello, world!" > "${{ steps.nginx.outputs.html-dir }}/index.html"
curl http://localhost:${{ steps.nginx.outputs.port }}/
# Expected output: Hello, world!
cat "${{ steps.nginx.outputs.access-log }}"
# Expected to contain a line with GET / HTTP/1.1 200
```
#### Input parameters
| Param | Description | Default |
@ -33,23 +49,6 @@ This action sets up a NGINX web server.
| access-log | The path to the NGINX access log file, unless conf-file-text is provided. |
| error-log | The path to the NGINX error log file, unless conf-file-text is provided. |
#### Basic
```yaml
steps:
- uses: nyurik/action-setup-nginx@v1
id: nginx
- run: |
echo "Hello, world!" > "${{ steps.nginx.outputs.html-dir }}/index.html"
curl http://localhost:${{ steps.nginx.outputs.port }}/
# Expected output: Hello, world!
cat "${{ steps.nginx.outputs.access-log }}"
# Expected to contain a line with GET / HTTP/1.1 200
```
## License
Licensed under either of