Downloads:

8,148

Downloads of v 1.16.1:

971

Last Update:

14 Aug 2019

Package Maintainer(s):

Software Author(s):

  • Igor Sysoev

Tags:

nginx service nssm

nginx service

1.16.1 | Updated: 14 Aug 2019

Downloads:

8,148

Downloads of v 1.16.1:

971

Software Author(s):

  • Igor Sysoev

nginx service 1.16.1

All Checks are Passing

2 Passing Test


Validation Testing Passed


Verification Testing Passed

Details

To install nginx service, run the following command from the command line or from PowerShell:

>

To upgrade nginx service, run the following command from the command line or from PowerShell:

>

To uninstall nginx service, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade nginx-service -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade nginx-service -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure nginx-service installed
  win_chocolatey:
    name: nginx-service
    state: present
    version: 1.16.1
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'nginx-service' do
  action    :install
  version  '1.16.1'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: nginx-service,
    Version: 1.16.1,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller nginx-service
{
   Name     = 'nginx-service'
   Ensure   = 'Present'
   Version  = '1.16.1'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'nginx-service':
  provider => 'chocolatey',
  ensure   => '1.16.1',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install nginx-service version="1.16.1" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator flcdrg on 10 Nov 2019.

Description

nginx [engine x] is an HTTP and reverse proxy server, a mail proxy server, and a generic TCP/UDP proxy server, originally written by Igor Sysoev.
This package provides an nssm Windows service wrapper for it which creates a standard Windows
service named nginx to manage the server.

N!B! This repository lists both nginx versions - stable and mainline:

  • Stable and mainline only differ by version numbers. On command choco install nginx-service the stable will be installed. To access mainline version, you must use pre-release --pre switch or specify exact version number, which has -mainline appended to it.
  • Mainline version might contain more edge features, whereas stable will be more prone to bugs. Both versions should receive critical security fixes. If you use this package for development and need to access latest features, go for mainline. If deployment is for longterm and unattended stability - choose stable.
  • More info on different nginx versions

During installation nginx-service will create following directory structure:

C:/tools/nginx/
├── conf
│   ├── nginx.original.conf {conf file shipped with official .zip}
│   ├── nginx.conf          {tailored version of above file}
│   └── ...
├── conf.d
│   └── server.default.conf
├── html
│   └── index.html
├── logs
│   └── {Required}
└── temp
    └── {Required}
  • Place your custom config files inside conf.d
  • Conf to be included must follow naming pattern server*.conf where * is a wildcard
  • Above allows config pattern where extra .conf files are included (and reused) manually from server*.conf, i.e. PHP location directive
  • It is safe to edit/rename/remove default config files. They will be restored during upgrade only if conf.d is empty

Afterwards, you can start and stop the service with following commands: nssm start nginx-service and nssm stop nginx-service
On default, the service will autostart with Windows. To disable this use Services GUI console.

See the nginx.org for more detailed documentation.


bin\nginx.exe.ignore
 
bin\nginx.zip
md5: AEE9302D2F7D7A80EAA0FC9F81F784D7 | sha1: DACD951E2EC74395013BAC7CC761C845DED905CC | sha256: D40DE53B4C1EB7F2E636C17B583B0A2AF5BFA6F1F78BB8B037D497C8300CB769 | sha512: 9BE95F1DFF1DE2E7BA891FB5C4B658CEB18D6CDFE4A34DEE48A995FBD0EA18EE5BF372C5D6E38F0295097DC2A2021F379CD6531131FE6924F4AF7A55C0FF8433
tools\chocolateyBeforeModify.ps1
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

. $toolsDir\chocolateyUninstall.ps1
tools\chocolateyinstall.ps1

$ErrorActionPreference = 'Stop'; # stop on all errors
$version    = $env:chocolateyPackageVersion -replace "(\d+)\.(\d+)\.(\d+).*",'$1.$2.$3'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$nginxDir   = "$($env:ChocolateyInstall)\lib\nginx-service\bin"
$installDir = "C:\tools\nginx"

$legacyDir = "C:\ProgramData\nginx\conf.d"


if(-not (Test-Path "$installDir\conf.d\")){
	New-Item -ItemType Directory -Force -Path "$installDir\conf.d\" | Out-Null
}

<#
	Determine if we need to try migrate config files from package version 1.6.2.1 and below
#>
$migratedOldConfig = $false
if ( (Test-Path "$legacyDir\") -eq $True -And (Test-Path "$legacyDir\nginx-service-migrated.dat") -eq $False){
	"Done on version $($env:ChocolateyPackageName) $($env:chocolateyPackageVersion), $(Get-Date)" | out-file "C:\ProgramData\nginx\conf.d\nginx-service-migrated.dat"
	Copy-Item "C:\ProgramData\nginx\conf.d\*" "$installDir\conf.d\" -Recurse -Force -include "*.conf"
	$migratedOldConfig = $true
}

<#
	Unpack ZIP file
#>
Get-ChocolateyUnzip -FileFullPath "$nginxDir\nginx.zip" -Destination "$nginxDir" -Force
Move-Item "$nginxDir\nginx-$version\*" "$nginxDir" -Force
Remove-Item "$nginxDir\nginx-$version" -Force -Recurse

<#
	Copy fresh config files from nginx conf
#>
Copy-Item "$nginxDir\*" $installDir -Recurse -Force -Exclude @("*.exe","*.ignore","html")

if(-not (Test-Path "$installDir\html")){
	New-Item -ItemType Directory -Force -Path "$installDir\html\" | Out-Null
	Copy-Item "$nginxDir\html\*" "$installDir\html" -Recurse -Force
}

Copy-Item "$installDir\conf\nginx.conf" "$installDir\conf\nginx.original.conf" -Force
Copy-Item "$toolsDir\conf\nginx.conf" "$installDir\conf" -Force


$confdInfo = Get-ChildItem "$installDir\conf.d" | Measure-Object
if($confdInfo.count -eq 0){
	Copy-Item "$toolsDir\conf.d\*" "$installDir\conf.d\" -Recurse -Force
}

<#
	Actual service installation
#>
$ErrorActionPreference = 'SilentlyContinue'

cmd /c "net stop nginx 2>&1" | Out-Null #remove old version
cmd /c "sc delete nginx 2>&1" | Out-Null #remove old version
cmd /c "net stop nginx-service 2>&1" | Out-Null
cmd /c "sc delete nginx-service 2>&1" | Out-Null

Install-BinFile -Name "nginx-service" -Path "$($env:ChocolateyInstall)\lib\nginx-service\bin\nginx.exe"

nssm install nginx-service "$($env:ChocolateyInstall)\bin\nginx-service.exe" 2>&1 | Out-Null
nssm set nginx-service Description "Awsome HTTP web server, service managed by NSSM" 2>&1 | Out-Null
nssm set nginx-service AppDirectory  "$installDir" 2>&1 | Out-Null
nssm set nginx-service AppParameters "-p """"$installDir""""" 2>&1 | Out-Null
nssm set nginx-service AppNoConsole 1 2>&1 | Out-Null # Mentioned on top off http://nssm.cc/download
nssm set nginx-service AppStopMethodSkip 7 2>&1 | Out-Null
nssm start nginx-service 2>&1 | Out-Null
$ErrorActionPreference = 'Stop'

<#
	Throw some barebones info for user
#>
Write-Host ""
if($migratedOldConfig){
	Write-Host "Migrated config from previous installation in ""$legacyDir\"","  -ForegroundColor Yellow
	Write-Host "remove completely or leave this dir as is" -ForegroundColor Yellow
	Write-Host "If you just remove '{Old conf.d}\nginx-service-migrated.dat' then," -ForegroundColor Yellow
	Write-Host "on next installation time, files will be imported again" -ForegroundColor Yellow
	Write-Host ""
}

Write-Host @"
Config file(s) location "$installDir\conf.d"

Nginx now can be started and stopped as regular Windows service or through NSSM command interface
Type one of those commands in CMD or PowerShell for nginx-service control:

"@  -ForegroundColor Green
Write-Host "To start service:" -ForegroundColor Green
Write-Host "    net start nginx-service" -ForegroundColor Yellow
Write-Host "    or" -ForegroundColor Green
Write-Host "    nssm start nginx-service" -ForegroundColor Yellow

Write-Host "To stop service:" -ForegroundColor Green
Write-Host "    net stop nginx-service" -ForegroundColor Yellow
Write-Host "    or" -ForegroundColor Green
Write-Host "    nssm stop nginx-service" -ForegroundColor Yellow

Write-Host "To restart service do both:" -ForegroundColor Green
Write-Host "    net stop nginx-service" -ForegroundColor Yellow
Write-Host "    net start nginx-service" -ForegroundColor Yellow
Write-Host "    or" -ForegroundColor Green
Write-Host "    nssm stop nginx-service" -ForegroundColor Yellow
Write-Host "    nssm start nginx-service" -ForegroundColor Yellow
tools\chocolateyuninstall.ps1

Write-Host "Removing nginx-service from services..." -ForegroundColor Red
$ErrorActionPreference = 'SilentlyContinue'
nssm stop nginx-service 2>&1 | Out-Null
nssm remove nginx-service confirm 2>&1 | Out-Null
Uninstall-BinFile -Name "nginx-service"
$ErrorActionPreference = 'Stop'
tools\conf.d\server.default.conf
server {
	listen       80;
	server_name  localhost;

	#charset koi8-r;

	#access_log  logs/host.access.log  main;

	location / {
		root   html;
		index  index.html index.htm;
	}

	#error_page  404              /404.html;

	# redirect server error pages to the static page /50x.html
	#
	error_page   500 502 503 504  /50x.html;
	location = /50x.html {
		root   html;
	}

	# proxy the PHP scripts to Apache listening on 127.0.0.1:80
	#
	#location ~ \.php$ {
	#    proxy_pass   http://127.0.0.1;
	#}

	# pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
	#
	#location ~ \.php$ {
	#    root           html;
	#    fastcgi_pass   127.0.0.1:9000;
	#    fastcgi_index  index.php;
	#    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
	#    include        fastcgi_params;
	#}

	# deny access to .htaccess files, if Apache's document root
	# concurs with nginx's one
	#
	#location ~ /\.ht {
	#    deny  all;
	#}
}
tools\conf\nginx.conf
#
#    DURING UPDATE THIS FILE WILL BE OVERWRITTEN
#    IF YOU HAVE IMPORTANT IMPROVEMENTS, CONTACT
#    ME ON chocolatey.org/packages/nginx-service
#

#user  nobody;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;


events {
    worker_connections  1024;
}


http {
    include       mime.types;
    default_type  application/octet-stream;

    #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
    #                  '$status $body_bytes_sent "$http_referer" '
    #                  '"$http_user_agent" "$http_x_forwarded_for"';

    #access_log  logs/access.log  main;

    sendfile        on;
    #tcp_nopush     on;

    #keepalive_timeout  0;
    keepalive_timeout  65;

    #gzip  on;


    # PLACE YOUR CUSTOM {server}.conf FILES INSIDE
    # C:/tools/nginx/conf.d/
    include ../conf.d/server*.conf;

}

tools\LICENSE.txt
/* 
 * Copyright (C) 2002-2018 Igor Sysoev
 * Copyright (C) 2011-2018 Nginx, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
tools\VERIFICATION.ps1

# This file provides verification of ZIP file shipped with this package.
#
# As nginx.org for each release provide a PGP signature, we will have to
# download signing public key, signature and verify it with bin\nginx.zip

$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

### Info on files
# Though, nginx has specific public hey titled for "signing packages and repositories",
# it is known that Maxim Dounin’s PGP public key is used to sign Windows zip releases
# https://nginx.org/en/pgp_keys.html
Invoke-WebRequest "https://nginx.org/keys/mdounin.key" -UseBasicParsing -OutFile "$toolsDir\..\bin\mdounin.key"

# Release zip obtained from
# https://nginx.org/en/download.html
# file is already stored as bin\nginx.zip

# Get original signature from
# https://nginx.org/en/download.html
Invoke-WebRequest "https://nginx.org/download/nginx-1.16.1.zip.asc" -UseBasicParsing -OutFile "$toolsDir\..\bin\nginx-1.16.1.zip.asc"

### Preperation
# Check that we have GPG 
choco install gpg4win -y | out-null

### Verify
# Import keys and verify ZIP file against the signature
gpg --import "$toolsDir\..\bin\mdounin.key"
gpg --verify "$toolsDir\..\bin\nginx-1.16.1.zip.asc" "$toolsDir\..\bin\nginx.zip"
tools\VERIFICATION.txt
VERIFICATION

Nginx for each release provide a ZIP file and .asc signature file.
Files are listed on the official page http://nginx.org/en/download.html

This package bin\ content includes the release ZIP file, obtained from https://nginx.org/download/nginx-1.16.1.zip

Package also includes VERIFICATION.ps1, which essentially does the following:

    1. Downloads Maxim Dounin’s publick key from https://nginx.org/en/pgp_keys.html
    2. Downloads signature for this release: https://nginx.org/download/nginx-1.16.1.zip.asc
    3. Verifies signature authenticity against bin\nginx.zip

File 'LICENSE.txt' is obtained from <https://nginx.org/LICENSE>

Package is built automatically with the AU module:
https://github.com/Pilskalns/choco-au-packages/tree/master/nginx-service

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
nginx service 1.17.3-mainline 59 Wednesday, August 14, 2019 Exempted
nginx service 1.16.0 491 Wednesday, April 24, 2019 Approved
nginx service 1.15.12-mainline 40 Wednesday, April 24, 2019 Exempted
nginx service 1.15.8-mainline 79 Wednesday, January 16, 2019 Exempted
nginx service 1.14.2 392 Friday, January 18, 2019 Approved
nginx service 1.14.1 380 Thursday, November 22, 2018 Approved
nginx-service (Install) 1.12.2 2264 Tuesday, February 27, 2018 Approved

*) Security: when using HTTP/2 a client might cause excessive memory
consumption and CPU usage (CVE-2019-9511, CVE-2019-9513,
CVE-2019-9516).


Discussion for the nginx service Package

Ground Rules:

  • This discussion is only about nginx service and the nginx service package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or nginx service, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus