2024-05-22 08:23:21 +08:00
|
|
|
# GitHub Action: Setup NGINX
|
|
|
|
|
|
|
|
|
|
[](https://github.com/nyurik/action-setup-nginx)
|
|
|
|
|
[](https://github.com/nyurik/action-setup-nginx/actions)
|
|
|
|
|
|
|
|
|
|
This action sets up a NGINX web server.
|
|
|
|
|
|
|
|
|
|
* Runs on Linux, macOS and Windows GitHub runners
|
|
|
|
|
* 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
|
2024-05-23 11:33:59 +08:00
|
|
|
* 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.
|
2024-05-22 08:23:21 +08:00
|
|
|
* [Easy to check](action.yml) that IT DOES NOT contain malicious code.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2024-05-23 11:33:59 +08:00
|
|
|
```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
|
|
|
|
|
```
|
|
|
|
|
|
2024-05-22 08:23:21 +08:00
|
|
|
#### Input parameters
|
|
|
|
|
|
|
|
|
|
| Param | Description | Default |
|
|
|
|
|
|----------------|-----------------------------------------------------------------------------|---------|
|
|
|
|
|
| port | The port number to use for the NGINX service, unless conf-file-text is set. | 8080 |
|
|
|
|
|
| conf-file-text | Optional content of the nginx.conf file, overrides the default one | |
|
|
|
|
|
|
|
|
|
|
#### Outputs
|
|
|
|
|
|
|
|
|
|
| Value | Description |
|
|
|
|
|
|------------|---------------------------------------------------------------------------------------------|
|
|
|
|
|
| bin | The path to the NGINX binary. |
|
|
|
|
|
| conf-path | The path to the NGINX configuration file. |
|
|
|
|
|
| html-dir | Default directory NGINX service uses as the root. This can be overridden by conf-file-text. |
|
|
|
|
|
| pid | The process ID of the NGINX service. |
|
|
|
|
|
| port | The port number used by the NGINX service. |
|
|
|
|
|
| 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. |
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Licensed under either of
|
|
|
|
|
|
|
|
|
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
|
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
|
|
|
|
|
at your option.
|
|
|
|
|
|
|
|
|
|
### Contribution
|
|
|
|
|
|
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally
|
|
|
|
|
submitted for inclusion in the work by you, as defined in the
|
|
|
|
|
Apache-2.0 license, shall be dual licensed as above, without any
|
|
|
|
|
additional terms or conditions.
|
