diff --git a/README.md b/README.md index 30f683a..97ad925 100644 --- a/README.md +++ b/README.md @@ -1,119 +1,90 @@ +[![GitHub stars](https://img.shields.io/github/stars/0xB4LINT/nginxconfig.io.svg)](https://github.com/0xB4LINT/nginxconfig.io/stargazers) +[![GitHub contributors](https://img.shields.io/github/contributors/0xB4LINT/nginxconfig.io.svg?color=blue)](https://github.com/0xB4LINT/nginxconfig.io/graphs/contributors) +[![MIT License](https://img.shields.io/github/license/0xB4LINT/nginxconfig.io.svg?color=blue)](https://github.com/0xB4LINT/nginxconfig.io/blob/master/LICENSE.md) +
+[![Closed issues](https://img.shields.io/github/issues-closed-raw/0xB4LINT/nginxconfig.io.svg?color=brightgreen)](https://github.com/0xB4LINT/nginxconfig.io/issues?q=is%3Aissue+is%3Aclosed) +[![Closed PR](https://img.shields.io/github/issues-pr-closed-raw/0xB4LINT/nginxconfig.io.svg?color=brightgreen)](https://github.com/0xB4LINT/nginxconfig.io/pulls?q=is%3Apr+is%3Aclosed) +[![Open issues](https://img.shields.io/github/issues-raw/0xB4LINT/nginxconfig.io.svg)](https://github.com/0xB4LINT/nginxconfig.io/issues) +[![Open PR](https://img.shields.io/github/issues-pr-raw/0xB4LINT/nginxconfig.io.svg)](https://github.com/0xB4LINT/nginxconfig.io/pulls) +
+[![Build status](https://img.shields.io/travis/com/0xB4LINT/nginxconfig.io.svg)](https://travis-ci.com/0xB4LINT/nginxconfig.io) +[![Uptime Robot ratio (7 days)](https://img.shields.io/uptimerobot/ratio/7/m779967051-bbb607d7a68973aaf01371fe.svg)](https://stats.uptimerobot.com/BqPYtQ74) +[![Google PageSpeed Insights](https://img.shields.io/badge/PageSpeed-90--100-brightgreen.svg)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fnginxconfig.io&tab=desktop) +[![Qualys SSL Labs](https://img.shields.io/badge/SSL%20Report-A+-brightgreen.svg)](https://www.ssllabs.com/ssltest/analyze.html?d=nginxconfig.io) +[![securityheaders.io](https://img.shields.io/badge/securityheaders.io-A-brightgreen.svg)](https://securityheaders.com/?q=https%3A%2F%2Fnginxconfig.io%2F) +[![HSTS preload](https://img.shields.io/hsts/preload/nginxconfig.io.svg?label=HSTS)](https://hstspreload.org/?domain=nginxconfig.io) + + [![nginxconfig.io](public/assets/img/github.png)](https://nginxconfig.io) -# NGiИX configuration generator +

+

⚙️ NGINX configuration generator on steroids 💉

+

+ The only tool you'll ever need to configure your NGINX server. +
+ nginxconfig.io » +
+
+ Report Bug + · + Request Feature +

+

-## Features -### Site -* Domain -* Path -* Document root -* www subdomain -* CDN -* Redirect www to non-www or non-www to www -* Listen IPv4, IPv6 +
-### HTTPS -* HTTPS -* HTTP2 -* Force HTTPS redirect -* [HSTS](https://hstspreload.org) -* [SSL profiles](https://mozilla.github.io/server-side-tls/ssl-config-generator/) -* Certification type - * [Let's Encrypt](https://letsencrypt.org) - * Custom certificate -* OCSP DNS resolvers - * [Cloudflare Resolver](https://www.cloudflare.com/dns/) - * [Google Public DNS](https://developers.google.com/speed/public-dns/) - * [OpenDNS](https://www.opendns.com) +# ✨ [nginxconfig.io](https://nginxconfig.io) +NGINX is so much more than just a webserver. You already knew that, probably. -### Security -* Referrer-Policy - * `no-referrer` - * `no-referrer-when-downgrade` - * `origin` - * `origin-when-cross-origin` - * `same-origin` - * `strict-origin` - * `strict-origin-when-cross-origin` - * `unsafe-url` -* Content-Security-Policy -* X-Frame-Options -* X-XSS-Protection -* X-Content-Type-Options -* `server_tokens` -* `limit_req` (throttle WordPress login) +We love NGINX, because: +* low memory usage +* high concurrency +* asynchronous event-driven architecture +* load balancing +* reverse proxying +* FastCGI support with caching (PHP) +* amazing fast handling of static files +* TLS/SSL with SNI +* **sexy config syntax** -### PHP -* PHP -* PHP server - * TCP - * HHVM socket - * 5.x socket - * 7.x socket -* PHP backup server -* WordPress security essentials -* Drupal security essentials -* Magento security essentials +A lot of features with corresponding configuration directives. You can deep dive into the [NGINX documentation]((http://nginx.org/en/docs/)) right now OR you can use this tool to check how NGINX works, observe how your inputs are affecting the output, generate the best config for your specific use-case (and in parallel you can still use the docs). -### Python -* Python -* Python server -* Python backup server +## 🚀 Usage +`GOTO` **[`nginxconfig.io`](https://nginxconfig.io)** -### Routing -* `index` -* Fallback routing - * index.php - * *[Laravel](https://laravel.com/docs/master/deployment#nginx)* - * *[Lumen](https://lumen.laravel.com/docs/5.1/installation#configuration)* - * *[Symfony](https://symfony.com/doc/current/setup/web_server_configuration.html#nginx)* - * *[Zend](https://www.nginx.com/resources/wiki/start/topics/recipes/zend/)* - * *[CodeIgniter](https://www.nginx.com/resources/wiki/start/topics/recipes/codeigniter/)* - * *[Yii](http://www.yiiframework.com/doc/guide/1.1/en/quickstart.apache-nginx-config#nginx)* - * *[CakePHP](https://book.cakephp.org/3.0/en/installation.html#nginx)* - * *[Slim](https://www.slimframework.com/docs/start/web-servers.html)* - * index.html - * *[Angular](https://angular.io/guide/deployment#production-servers)* - * *[React](https://github.com/react-boilerplate/react-boilerplate/blob/v3.5.0/app/.nginx.conf#L81)* - * *[Vue.js](https://stackoverflow.com/questions/47655869/how-to-use-vue-js-with-nginx)* - * *[Ember.js](https://discuss.emberjs.com/t/how-to-serve-all-routes-on-a-production-server-exactly/6372)* -* Fallback routing PHP (SPA + API support) +**Features:** +HTTPS, HTTP/2, IPv6, certbot, HSTS, security headers, SSL profiles, OCSP resolvers, caching, gzip, brotli, fallback routing, reverse proxy, www/non-www redirect, CDN, PHP (TCP/socket, WordPress, Drupal, Magento), Node.js, Python (Django), etc. -### Cache -* Assets (`css(\.map)?|js(\.map)?`) -* Media - * Images (`jpe?g|png|gif|ico|cur|heic|webp|tiff?`) - * Audio (`mp3|m4a|aac|ogg|midi?|wav`) - * Video (`mp4|mov|webm|mpe?g|avi|ogv|flv|wmv`) -* SVG (`svgz?`) -* Fonts (`ttf|ttc|otf|eot|woff2?`) +## 👨‍💻 Author +**Bálint Szekeres <balint@szekeres.me> (https://balint.szekeres.me)** +* GitHub: [@0xB4LINT](https://github.com/0xB4LINT) +* LinkedIn: [@0xB4LINT](https://www.linkedin.com/in/0xB4LINT/) -### Reverse proxy -* Reverse proxy -* Path -* `proxy_pass` -* Proxy headers +## ▶️ Install locally +1. Clone the repository + ```sh + git clone https://github.com/0xB4LINT/nginxconfig.io.git + ``` +1. Install NPM packages + ```sh + npm install + ``` +1. Build assets & run server + ```sh + npm start + ``` +1. Open **[127.0.0.1:8080](http://127.0.0.1:8080)** -### Logging -* `access_log` -* `error_log` -* `access_log` by domain -* `error_log` by domain -* `log_not_found` +## 🤝 Contributing +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. -### nginx -* `worker_processes` -* `user` -* `pid` -* `client_max_body_size` +1. Fork the Project +1. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +1. Commit your Changes (`git commit -m 'Add some AmazingFeature`) +1. Push to the Branch (`git push origin feature/AmazingFeature`) +1. Open a Pull Request -### Tools -* Download generated config -* Modularized / unified structure (multiple or singe file(s)) -* Share settings -* Reset - -## Built With +## ⚒️ Built With * [Bootstrap](http://getbootstrap.com) - Grid, form controls * [AngularJS](https://angularjs.org) - Two-way data binding, template handling * [highlight.js](https://highlightjs.org) - nginx syntax highlight @@ -125,7 +96,7 @@ * [FileSaver](https://github.com/eligrey/FileSaver.js) - downloading zip file * [notie](https://jaredreich.com/notie/) - toast notifications -## Resources +## 📚 Resources * [OWASP TLS Cipher String Cheat Sheet](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/TLS_Cipher_String_Cheat_Sheet.md) * [Nginx Optimization: understanding sendfile, tcp_nodelay and tcp_nopush](https://thoughts.t37.net/nginx-optimization-understanding-sendfile-tcp-nodelay-and-tcp-nopush-c55cdd276765) * [NGINX Tuning For Best Performance](https://gist.github.com/denji/8359866) @@ -134,3 +105,10 @@ * [Diffie-Hellman DSA-like parameters](https://security.stackexchange.com/questions/95178/diffie-hellman-parameters-still-calculating-after-24-hours/95184#95184) * [hstspreload.org](https://hstspreload.org) * [Optimal value for nginx worker_connections](https://serverfault.com/questions/787919/optimal-value-for-nginx-worker-connections) + +## ⭐️ Show your support +Give a ⭐️ if this project helped you! + +## 📝 License +Copyright © 2019 [Bálint Szekeres <balint@szekeres.me> (https://balint.szekeres.me)](https://github.com/0xB4LINT).
+This project is [MIT](https://github.com/0xB4LINT/nginxconfig.io/blob/master/LICENSE) licensed.