Downloads:

8,148

Downloads of v 1.14.1:

380

Last Update:

22 Nov 2018

Package Maintainer(s):

Software Author(s):

  • Igor Sysoev

Tags:

nginx service nssm

nginx service

This is not the latest version of nginx service available.

1.14.1 | Updated: 22 Nov 2018

Downloads:

8,148

Downloads of v 1.14.1:

380

Software Author(s):

  • Igor Sysoev

nginx service 1.14.1

This is not the latest version of nginx service available.

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.14.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.14.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.14.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.14.1'
   Source   = 'STEP 3 URL'
}

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


package { 'nginx-service':
  provider => 'chocolatey',
  ensure   => '1.14.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.14.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 gep13 on 23 Nov 2018.

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! Upgrading from nginx-service 1.6.2.1 and below it will have new default configuration location.

It may be disappointing, but here's few reasons why:

  • Writing inside previous C:/ProgramData/nginx requires editor to be opened with Administrator privileges
  • Changing to new directory allow for optimistic migration from 1.6.2.1 to 1.14.1
  • 1.6.2.1 is a quite old and I believe most of users have already found another way for newer nginx. Those who dont, probably also wont bother updating to newer
  • C:/tools/nginx is on par with other web-related choco packages

During installation nginx-service will create following directory structure:

C:/tools/nginx/
├── conf
│   ├── nginx.conf
│   └── ...
├── conf.d
│   ├── server.default.conf
│   └── server.d0n3.ws.conf.sample {Bonus file, read content}
├── 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

See the nginx.org for more detailed documentation.


tools\chocolateyinstall.ps1

$ErrorActionPreference = 'Stop'; # stop on all errors
$version    = $env:chocolateyPackageVersion -replace "-beta.*",""
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$nginxDir   = "$($env:ChocolateyInstall)\lib\nginx\tools\nginx-$($version)"
$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
}

<#
	Copy fresh config files from nginx conf
#>
Copy-Item "$nginxDir\*" $installDir -Recurse -Force -Exclude @("*.exe","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 "$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'

net stop nginx 2>&1 | Out-Null # Wishfull thinking
sc delete nginx 2>&1 | Out-Null # Wishfull thinking

nssm stop nginx 2>&1 | Out-Null
nssm remove nginx confirm 2>&1 | Out-Null
nssm install nginx "$($env:ChocolateyInstall)\bin\nginx.exe" 2>&1 | Out-Null
nssm set nginx Description "Awsome HTTP web server, service managed by NSSM" 2>&1 | Out-Null
nssm set nginx AppDirectory  "$installDir" 2>&1 | Out-Null
nssm set nginx AppParameters "-p """"$installDir""""" 2>&1 | Out-Null
nssm set nginx AppNoConsole 1 2>&1 | Out-Null # Mentioned on top off http://nssm.cc/download
nssm set nginx AppStopMethodSkip 7 2>&1 | Out-Null
nssm start nginx 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" -ForegroundColor Yellow
Write-Host "    or" -ForegroundColor Green
Write-Host "    nssm start nginx" -ForegroundColor Yellow

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

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

$ErrorActionPreference = 'SilentlyContinue'
nssm stop nginx 2>&1 | Out-Null
nssm remove nginx confirm 2>&1 | Out-Null
$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.d\server.done.ws.conf.sample
 
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.
 */


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 (CVE-2018-16843) and CPU usage (CVE-2018-16844).

*) Security: processing of a specially crafted mp4 file with the
ngx_http_mp4_module might result in worker process memory disclosure
(CVE-2018-16845).

*) Bugfix: working with gRPC backends might result in excessive memory
consumption.


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