gnussonnet/cli-webserver

This CLI simplifies the creation and renewal of a webserver running with SSL certificates. With a modified Nginx Dockerfile and Let's Encrypts client called Certbot, it takes seconds to be up and running.

🔥 cli-webserver, simplifies webservers 🔥

This CLI simplifies the creation and renewal of a webserver running with SSL certificates. With a modified Nginx Dockerfile and Let's Encrypts client called Certbot, it takes seconds to be up and running.

🕵🏽 Report Bug - ✍🏼 Contact - 🙇 Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Perquisites
   • Installation
   • Uninstall
3. Usage
   • Setup Webserver
   • Command-line options
4. Contributing
5. License
6. Contact
7. Acknowledgments

Built With

• Node
• Docker
• NGINX
• NPM Dependencies

Getting Started

Disclaimer

This project is still under development which means it have not been tested on other machines, USE AT YOUR OWN RISK.

Perquisites

Your system must have these following packages installed and running:

• Docker
• Node

Installation

1. Install via NPM (globally)

   npm install -g cli-webserver

Uninstall

1. Uninstall via NPM (globally)

   npm uninstall -g cli-webserver

Usage

This script is farley straight forward to use

Setup Webserver

1. Run the CLI

   webserver <environment> [options]

   or

   cliWebserver <environment> [options]

   or

   cli-webserver <environment> [options]

   Then follow the instructions on the screen

Webserver command-line options

Option	Arguments	Description
environment	development, production	Skips first question regarding dev/prod menu
-d	domain.com	Your domain is passed to Certbot and NGINX
-f	PATH to frontend directory	Path to your frontend directory
-c	PATH to nginx config file	Path to your nginx config file
-p	0-9999	Port to expose host (only development)
-e	[email protected]	Email to register certificate (passed directly to Certbot)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Filip "Gnusson" Magnusson - @GnussonNet - [email protected]

Project Link: [Github.com/GnussonNet/cli-webserver(https://github.com/GnussonNet/cli-webserver)

Acknowledgments

Special thanks to the below users who gave me a great start when creating this project.

• Jonas Alfredssons repository docker-nginx-certbot
• othneildrews readme template Best README Template