Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jirutka/nginx-json-schema
JSON schema for NGINX configuration
https://github.com/jirutka/nginx-json-schema
json-schema nginx
Last synced: 10 days ago
JSON representation
JSON schema for NGINX configuration
- Host: GitHub
- URL: https://github.com/jirutka/nginx-json-schema
- Owner: jirutka
- License: mit
- Created: 2024-05-12T20:31:19.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-05-23T23:24:24.000Z (7 months ago)
- Last Synced: 2024-10-31T03:42:10.160Z (about 2 months ago)
- Topics: json-schema, nginx
- Language: TypeScript
- Homepage:
- Size: 182 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= NGINX JSON Schema
:proj-name: nginx-json-schema
:gh-name: jirutka/{proj-name}
TBD
https://jirutka.github.io/{proj-name}/nginx-full.json
== Tools
* https://github.com/jirutka/nginx-jsconf[nginx-jsconf] – JS library and a CLI tool to convert nginx configuration from YAML or JSON to nginx config format
* link:scripts/nginx-json-schema-filter.mjs[nginx-json-schema-filter] – Script to remove selected nginx modules from nginx-full.json
== Examples
Directive without a value::
+
[source, nginx]
ip_hash;
+
[source, yaml]
ip_hash: null
Repeated directive::
+
[source, nginx]
allow 127.0.0.1;
allow ::1;
+
[source, yaml]
allow:
- 127.0.0.1
- ::1
Block directive without a parameter::
+
[source, nginx]
----
events {
worker_connections 4096;
}
----
+
[source, yaml]
events:
worker_connections: 4096
Block directive with a parameter::
+
[source, nginx]
----
location ~ ^/api/v[0-9]+/ {
index on;
}
location / {
index on;
}
----
+
[source, yaml]
location:
'~ ^/api/v[0-9]+/':
index: on
/:
index: on
Repeated directive in object notation::
+
[source, nginx]
proxy_set_header Host $http_host;
proxy_set_header Forwarded $proxy_add_forwarded;
+
[source, yaml]
proxy_set_header:
Host: $http_host
Forwarded: $proxy_add_forwarded
Single directive with a scalar value::
+
[source, nginx]
proxy_buffering off
+
[source, yaml]
proxy_buffering: false
== License
This project is licensed under https://opensource.org/license/mit/[MIT License].