NCV.NginxConfigParser 0.1.3

There is a newer version of this package available.
See the version list below for details.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.
dotnet add package NCV.NginxConfigParser --version 0.1.3
NuGet\Install-Package NCV.NginxConfigParser -Version 0.1.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NCV.NginxConfigParser" Version="0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NCV.NginxConfigParser --version 0.1.3
#r "nuget: NCV.NginxConfigParser, 0.1.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NCV.NginxConfigParser as a Cake Addin
#addin nuget:?package=NCV.NginxConfigParser&version=0.1.3

// Install NCV.NginxConfigParser as a Cake Tool
#tool nuget:?package=NCV.NginxConfigParser&version=0.1.3

NGINX configuration file parser and builder

A .net standard library for reading and writing nginx configuration files.

Quick start

Install nuget package NuGet

Create new file

NginxConfig.Create()
    .AddOrUpdate("http:server:listen", "80")
    .AddOrUpdate("http:server:root", "/var/wwwroot")
    // add location
    .AddOrUpdate("http:server:location", "/", true, "default")
    .AddOrUpdate("http:server:location:root", "/app1")
    // add location
    .AddOrUpdate("http:server:location[1]", "~ ^/(images|javascript|js|css|flash|media|static)/", true)
    .AddOrUpdate("http:server:location[1]:root", "/app2")
    .AddOrUpdate("http:server:location[1]:expires", "1d")
    // add location
    .AddOrUpdate("http:server:location[2]", "~/api", true, "api")
    .AddOrUpdate("http:server:location[2]:proxy_pass", "http://server.com")
    // save file
    .Save("temp2.conf");

The temp2.conf file content :

http   {

  server   {
    listen  80;
    root  /var/wwwroot;

    location  / { # default
      root  /app1;
    }

    location  ~ ^/(images|javascript|js|css|flash|media|static)/ {
      root  /app2;
      expires  1d;
    }

    location  ~/api { # api
      proxy_pass  http://server.com;
    }

  }
}

Read exist file

// load from file
var config = NginxConfig.LoadFrom("nginx.conf");

// read single value
Console.WriteLine(config.GetToken("worker_processes")); // read the root key 'worker_processes'
Console.WriteLine(config["http:log_format"])); // read the key 'log_format' from http section
Console.WriteLine(config["http:server[2]:root"])); // read the key 'root' from second http server

// read multi values
// read all values by key 'include' from http section
config.GetTokens("http:include").ToList().ForEach(item =>
{
    Console.WriteLine(item);
});

// read all group section
Console.WriteLine(config.GetGroup("http"));  // get all from group key 'http'

// add or update value
config.AddOrUpdate("http:root", "/var/wwwroot");
config.AddOrUpdate("http:server:root", "/var/wwwroot/server1");
config.AddOrUpdate("http:server[2]:root", "/var/wwwroot/server2");

// add group
config.AddOrUpdate("http:server:location", "/api", true, comment: "new location");
// add value to group
config.AddOrUpdate("http:server:location:root", "/var/wwwroot/api");
Console.WriteLine(config["http:server:location:root"]);

// delete value
config.Remove("http:server:access_log"); // remove by key
config.Remove("http:server:location"); // remove the location section

// save to file
config.Save("nginx.conf");
// or get file content
string configContent = config.ToString();

Buy Me A Coffee

"Buy Me A Coffee"

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.4 100 5/5/2024

Allows keys having spaces too (for rtmp mod)