https://github.com/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.
https://github.com/gnussonnet/cli-webserver
cli cli-app cli-webserver letsencrypt nginx nodejs ssl ssl-certificates websever
Last synced: 5 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/gnussonnet/cli-webserver
- Owner: GnussonNet
- License: mit
- Created: 2022-05-28T14:36:31.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-04T13:29:11.000Z (about 4 years ago)
- Last Synced: 2025-08-31T19:21:40.340Z (10 months ago)
- Topics: cli, cli-app, cli-webserver, letsencrypt, nginx, nodejs, ssl, ssl-certificates, websever
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/cli-webserver
- Size: 769 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🔥 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
## Built With
* [Node](https://nodejs.org)
* [Docker](https://www.docker.com/)
* [NGINX](https://nginx.org/)
* [NPM Dependencies](hhttps://www.npmjs.com/package/cli-webserver)
## 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](https://www.docker.com)
* [Node](https://nodejs.org)
### Installation
1. Install via NPM (globally)
```sh
npm install -g cli-webserver
```
### Uninstall
1. Uninstall via NPM (globally)
```sh
npm uninstall -g cli-webserver
```
## Usage
This script is farley straight forward to use
### Setup Webserver
1. Run the CLI
```sh
webserver [options]
```
or
```sh
cliWebserver [options]
```
or
```sh
cli-webserver [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 | `name@domain.com` | 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!
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](https://twitter.com/GnussonNet) - admin@gnusson.net
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](https://github.com/JonasAlfredsson) repository [docker-nginx-certbot](https://github.com/JonasAlfredsson/docker-nginx-certbot/blob/master/src/Dockerfile-alpine)
* [othneildrews](https://github.com/othneildrew) readme template [Best README Template](https://github.com/othneildrew/Best-README-Template)