Merge pull request #2 from regru/85773_readme_update
85773 readme update
This commit is contained in:
commit
524b2d705e
100
README.md
100
README.md
|
@ -1,74 +1,34 @@
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/stargazers)
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/graphs/contributors)
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE)
|
|
||||||
<br />
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/issues?q=is%3Aissue+is%3Aclosed)
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/pulls?q=is%3Apr+is%3Aclosed)
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/issues)
|
|
||||||
[](https://github.com/digitalocean/nginxconfig.io/pulls)
|
|
||||||
|
|
||||||
[](https://do.co/nginxconfig)
|
|
||||||
|
|
||||||
<h3 align="center">⚙️ NGINX configuration generator on steroids 💉</h3>
|
<h3 align="center">⚙️ NGINX configuration generator on steroids 💉</h3>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
The only tool you'll ever need to configure your NGINX server.
|
The only tool you'll ever need to configure your NGINX server.
|
||||||
<br />
|
<br />
|
||||||
<a href="https://do.co/nginxconfig"><strong>do.co/nginxconfig »</strong></a>
|
This is the fork of very useful open-source project by Digital Ocean, here's more information about this project:
|
||||||
<br />
|
<br />
|
||||||
<br />
|
<a href="https://github.com/digitalocean/nginxconfig.io"><strong>github.com/digitalocean/nginxconfig.io »</strong></a>
|
||||||
<a href="https://github.com/digitalocean/nginxconfig.io/issues/new?template=report-a-bug.md">Report a bug</a>
|
|
||||||
·
|
|
||||||
<a href="https://github.com/digitalocean/nginxconfig.io/issues/new?template=request-a-feature.md">Request a feature</a>
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
# ✨ [NGINX Config](https://do.co/nginxconfig)
|
# ✨ About this fork
|
||||||
|
|
||||||
NGINX is so much more than just a webserver. You already knew that, probably.
|
This fork is used to implement Digital Ocean's NGINX configurator to REG.RU web-site with some cosmetic tune-ups:
|
||||||
|
|
||||||
We love NGINX, because:
|
* unneccessary Digital Ocean stuff removed
|
||||||
* low memory usage
|
* some styles updated to match REG.RU style-guide
|
||||||
* high concurrency
|
* some layout improvements implemented
|
||||||
* asynchronous event-driven architecture
|
* static build added to Github repo for deployment
|
||||||
* load balancing
|
|
||||||
* reverse proxying
|
|
||||||
* FastCGI support with caching (PHP)
|
|
||||||
* amazing fast handling of static files
|
|
||||||
* TLS/SSL with SNI
|
|
||||||
|
|
||||||
A lot of features with corresponding configuration directives.
|
No any logic updates made here, it works just like ofirinal project.
|
||||||
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).
|
|
||||||
|
|
||||||
## 🚀 Usage
|
## 🚀 Usage
|
||||||
|
|
||||||
`GOTO` **[`do.co/nginxconfig`](https://do.co/nginxconfig)**
|
`GOTO` **[`reg.ru/web-tools/nginx-config-generator`](https://www.reg.ru/web-tools/nginx-config-generator)**
|
||||||
|
|
||||||
**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, Joomla), Node.js support, Python
|
|
||||||
(Django) server, etc.
|
|
||||||
|
|
||||||
## 👨💻 Author
|
|
||||||
|
|
||||||
### Rewrite & maintenance
|
|
||||||
|
|
||||||
**Matt (IPv4) Cowley <me@mattcowley.co.uk> (https://mattcowley.co.uk)**
|
|
||||||
* GitHub: [@MattIPv4](https://github.com/MattIPv4)
|
|
||||||
|
|
||||||
### Original version
|
|
||||||
|
|
||||||
**Bálint Szekeres <balint@szekeres.me> (https://balint.szekeres.me)**
|
|
||||||
* GitHub: [@0xB4LINT](https://github.com/0xB4LINT)
|
|
||||||
* LinkedIn: [@0xB4LINT](https://www.linkedin.com/in/0xB4LINT/)
|
|
||||||
|
|
||||||
## ▶️ Development
|
## ▶️ Development
|
||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/digitalocean/nginxconfig.io.git
|
git clone https://github.com/regru/nginxconfig.io.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install NPM packages
|
2. Install NPM packages
|
||||||
|
@ -95,45 +55,37 @@ routing, reverse proxy, www/non-www redirect, CDN, PHP (TCP/socket, WordPress, D
|
||||||
|
|
||||||
7. Build for production *(to the `dist` directory)*
|
7. Build for production *(to the `dist` directory)*
|
||||||
```sh
|
```sh
|
||||||
npm run build
|
npm run build:regru-static
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create.
|
1. Clone the project
|
||||||
Any contributions you make are **greatly appreciated**.
|
|
||||||
|
|
||||||
1. Fork the Project
|
|
||||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
5. Open a Pull Request
|
5. Open a Pull Request
|
||||||
|
|
||||||
## ⚒️ Built With
|
## 👨💻 Author
|
||||||
|
|
||||||
* [Vue.js](https://vuejs.org/) - Template handling & app generation
|
### Rewrite & maintenance of this fork
|
||||||
* [Bulma](https://bulma.io/) - Base styling, customised by [do-bulma](https://github.com/do-community/do-bulma)
|
**Valery Kovalev <v.kovalev@reg.ru> (https://reg.ru)**
|
||||||
* [Prism](https://prismjs.com/) - Bash & NGINX syntax highlighting
|
|
||||||
|
|
||||||
## 📚 Resources
|
### Rewrite & maintenance of Digital Ocean project
|
||||||
|
|
||||||
* [Mozilla SSL Configuration Generator v5](https://ssl-config.mozilla.org)
|
**Matt (IPv4) Cowley <me@mattcowley.co.uk> (https://mattcowley.co.uk)**
|
||||||
* [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/)
|
* GitHub: [@MattIPv4](https://github.com/MattIPv4)
|
||||||
* [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)
|
|
||||||
* [Hardening Your HTTP Security Headers](https://www.keycdn.com/blog/http-security-headers/)
|
|
||||||
* [h5bp/server-configs-nginx](https://github.com/h5bp/server-configs-nginx)
|
|
||||||
* [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
|
### Original version
|
||||||
|
|
||||||
Give a ⭐️ if this project helped you!
|
**Bálint Szekeres <balint@szekeres.me> (https://balint.szekeres.me)**
|
||||||
|
* GitHub: [@0xB4LINT](https://github.com/0xB4LINT)
|
||||||
|
* LinkedIn: [@0xB4LINT](https://www.linkedin.com/in/0xB4LINT/)
|
||||||
|
|
||||||
## 📝 License
|
## 📝 License
|
||||||
|
|
||||||
Copyright © 2020 [DigitalOcean, Inc <contact@digitalocean.com> (https://www.digitalocean.com)](https://www.digitalocean.com).
|
Copyright © 2021 [Reg.ru, Inc (https://www.reg.ru)](https://www.reg.ru).
|
||||||
|
<br />
|
||||||
|
Copyright © 2021 [DigitalOcean, Inc <contact@digitalocean.com> (https://www.digitalocean.com)](https://www.digitalocean.com).
|
||||||
<br />
|
<br />
|
||||||
This project is licensed under the [MIT](https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE) license.
|
This project is licensed under the [MIT](https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE) license.
|
||||||
|
|
File diff suppressed because one or more lines are too long
|
@ -25,10 +25,10 @@ THE SOFTWARE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
.header {
|
.header {
|
||||||
padding: ($margin) ($margin * 0.5) 0;
|
padding: ($margin * 2) ($margin * 0.5) 0;
|
||||||
|
|
||||||
@media (min-width: $breakpoint) {
|
@media (min-width: $breakpoint) {
|
||||||
padding: ($margin) 0 0;
|
padding: ($margin * 2) 0 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.container {
|
.container {
|
||||||
|
|
Loading…
Reference in New Issue