Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tufanbarisyildirim/gonginx
Nginx configuration parser helps you to parse, edit, regenerate your nginx config in your go applications
https://github.com/tufanbarisyildirim/gonginx
devops devops-tools golang lexer nginx parser
Last synced: 16 days ago
JSON representation
Nginx configuration parser helps you to parse, edit, regenerate your nginx config in your go applications
- Host: GitHub
- URL: https://github.com/tufanbarisyildirim/gonginx
- Owner: tufanbarisyildirim
- License: mit
- Created: 2020-04-05T11:42:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T13:50:31.000Z (2 months ago)
- Last Synced: 2024-09-07T15:22:36.963Z (2 months ago)
- Topics: devops, devops-tools, golang, lexer, nginx, parser
- Language: Go
- Homepage: https://github.com/tufanbarisyildirim/gonginx
- Size: 337 KB
- Stars: 165
- Watchers: 4
- Forks: 46
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Gonginx
TBH, I would like to rewrite the parser next time I need it again :)) but it still does its job.
Gonginx is an Nginx configuration parser helps you to parse, edit, regenerate your nginx config files in your go applications. It makes managing your balancer configurations easier.
## Basic grammar of an nginx config file
```yacc
%token Keyword Variable BlockStart BlockEnd Semicolon Regex
%%
config : /* empty */
| config directives
;
block : BlockStart directives BlockEnd
;
directives : directives directive
;
directive : Keyword [parameters] (semicolon|block)
;
parameters : parameters keyword
;
keyword : Keyword
| Variable
| Regex
;
```
## API
## Core Components
- ### [Parser](/parser/parser.go)
Parser is the main package that analyzes and turns nginx structred files into objects. It basically has 3 libraries, `lexer` explodes it into `token`s and `parser` turns tokens into config objects which are in their own package,
- ### [Config](/config/config.go)
Config package is representation of any context, directive or their parameters in golang. So basically they are models and also AST
- ### [Dumper](/dumper/dumper.go)
Dumper is the package that holds styling configuration only.
## Examples
- [Formatting](/examples/formatting/main.go)
- [Adding a Server to upstream block](/examples/adding-server/main.go)
- [add-custom-directive](/examples/add-custom-directive/main.go)
- [dump-nginx-config](/examples/dump-nginx-config/main.go)
- [update-directive](/examples/update-directive/main.go)
- [update-server-listen-port](/examples/update-server-listen-port/main.go)
### [Examples and Library Reference](/GUIDE.md)
#### TODO
- [x] associate comments with config objects to print them on config generation and make it configurable with `dumper.Style`
- [x] move any context wrapper into their own file (remove from parser)
- [x] Parse included files recusively, keep relative path on load, save all in a related structure and make that optional in dumper.Style
- [ ] Implement specific searches, like finding servers by server_name (domain) or any upstream by target etc.
- [ ] add more examples
- [x] link the parent directive to any directive for easier manipulation
## Limitations
There is no known limitations yet. PRs are more than welcome if you want to implement a specific directive / block, please read [Contributing](CONTRIBUTING.md) before your first PR.
## License
[MIT License](LICENSE)