nginxconfig.io README

The project's README from github.com/digitalocean/nginxconfig.io. As one markdown file: README.md.

GitHub stars GitHub contributors MIT License
Closed issues Closed PR Open issues Open PR

nginxconfig

⚙️ NGINX configuration generator on steroids 💉

The only tool you'll ever need to configure your NGINX server.
do.co/nginxconfig »

Report a bug · Request a feature


✨ NGINX Config

NGINX is so much more than just a webserver. You already knew that, probably.

We love NGINX, because:

A lot of features with corresponding configuration directives. You can deep dive into the NGINX documentation right now OR you can use this tool to check how NGINX works, observe how your inputs are affecting the output, and generate the best config for your specific use-case (in parallel you can also still use the docs).

🚀 Usage

GOTO do.co/nginxconfig

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 <[email protected]> (https://mattcowley.co.uk)

Original version

Bálint Szekeres <[email protected]> (https://balint.szekeres.me)

▶️ Development

  1. Clone the repository

    git clone https://github.com/digitalocean/nginxconfig.io.git
    
  2. Install NPM packages

    npm ci
    
  3. Run the development server (with file watchers)

    npm run dev
    
  4. Open the development site localhost:8080

  5. Lint your code (eslint & stylelint)

    npm test
    
  6. Build for production (to the dist directory)

    npm run build
    

🤝 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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

⚒️ Built With

📚 Resources

⭐️ Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 DigitalOcean, Inc <[email protected]> (https://www.digitalocean.com).
This project is licensed under the MIT license.

nginxconfig.io (digitalocean/nginxconfig.io)

rate-limiting
Searching Database…

What is this?A free web-based NGINX configuration generator by DigitalOcean: you pick what your server needs and it produces a tuned config for your use case.
Is this a website I visit, or something I install on my server?It's a website — open do.co/nginxconfig in a browser and it builds the config as you answer questions. You install nothing; touching the code is only for developing the tool itself.
Can I run the generator myself instead of using the hosted site?Yes — it's a Vue.js app: clone the repo, run npm install, then npm run dev serves it at localhost:8080, and npm run build writes a static build to the dist directory.
Do I need a DigitalOcean account to use it?No. It's a public website — the README mentions no account, login or API key; you just open it and describe your setup.
Does it help with Let's Encrypt certificates?Yes — certbot support is one of the listed features, so the generated config can include a certbot setup alongside the HTTPS, HSTS and SSL profile options.
Is the project still active?It looks healthy: the repo is not archived, counts about 28,000 stars, and names an active maintainer (MattIPv4) for the rewrite, with DigitalOcean behind the project.
Size
9.3 MB
Stars
28.3K
Updated
CommitOct 04
Age
8y
Commits · 90 Days