cli-webserver
v0.0.7
Published
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.
Downloads
12
Maintainers
Readme
Table of Contents
Built With
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:
Installation
- Install via NPM (globally)
npm install -g cli-webserver
Uninstall
- Uninstall via NPM (globally)
npm uninstall -g cli-webserver
Usage
This script is farley straight forward to use
Setup Webserver
Run the CLI
webserver <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 | null
-d | domain.com
| Your domain is passed to Certbot and NGINX | null
-f | PATH to frontend directory
| Path to your frontend directory | null
-c | PATH to nginx config file
| Path to your nginx config file | null
-p | 0-9999
| Port to expose host (only development) | null
-e | [email protected]
| Email to register certificate (passed directly to Certbot) | null
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - 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