Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webtinkle/webtinkle
NGINX configuration generator tool
https://github.com/webtinkle/webtinkle
nginx nginx-configuration
Last synced: 3 months ago
JSON representation
NGINX configuration generator tool
- Host: GitHub
- URL: https://github.com/webtinkle/webtinkle
- Owner: webtinkle
- License: gpl-3.0
- Created: 2018-12-27T13:19:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:29:01.000Z (about 2 years ago)
- Last Synced: 2024-10-12T03:26:16.546Z (4 months ago)
- Topics: nginx, nginx-configuration
- Language: TypeScript
- Homepage:
- Size: 491 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebTinkle
NGINX configuration generator tool
> /!\ Currently, WebTinkle is in an early stage and must not be used in production /!\
## Install
WebTinkle depends on NodeJS 6.4.0 or later and can be installed with npm (generally bundled with NodeJS) using this command:
```bash
npm i -g webtinkle
```
## How to use
### Templates
The most important part of WebTinkle is templating. Templates allows to make an NGINX configuration adapted to the needs.
WebTinkle doesn't contains any templates himself, but provides a command to download templates, the [`webtinkle install`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-install) command:
```bash
webtinkle install
```
It will download the specified template from [this GitHub repository](https://github.com/webtinkle/webtinkle-templates) and install those automatically.
If you want to remove an installed template, use [`webtinkle uninstall`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-uninstall) command:
```bash
webtinkle uninstall
```
### Website
To add a website to NGINX configs, use the [`webtinkle add`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-add) command:
```bash
webtinkle add -t
```
To remove a website from NGINX configs, use the [`webtinkle remove`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-remove) command:
```bash
webtinkle remove
```
## Troubleshooting
### nginx.configFolder must point to a directory
It means that your NGINX configuration path is not a valid folder.
nginx.configFolder must point to a path where he would be able to put the NGINX configurations.
In most computers, this folder is located at `/etc/nginx/conf.d/`, but sometimes, it must point to a different folder.
To change the location where WebTinkle put its configurations, you must do the command:
```
webtinkle config nginx.configFolder
```
## Contribute
### Getting Started
First, WebTinkle requires yarn to handle its dependencies, so make sure you have it to avoid trouble.
To start, you need to clone the repository. When you've done this, install all dependencies using the command below:
```bash
yarn
```
It should load all dependencies. After that you can contribute.
### Build Project
Gulp must be used to build WebTinkle so be sure to have it. When you have it, depending of the wanted build kind, execute the following commands.
#### Developement Build
Developement build are builds made to be built faster and to provide more informations to developers.
```bash
gulp dev
```
#### Production Build
Production build are build made to be more optimized for a publication.
```bash
gulp prod
```
### Execute Commands
WebTinkle provides a script to test the commands, to use it, instead of using `webtinkle` at the start of your commands, use the following:
```bash
yarn cli ...
```
For example, `webtinkle install proxy` becomes `yarn cli install proxy`.
### Show Logs
WebTinkle has a command option named `--loglevel`, or simply `-L`. It can be used to provide more or less logs depending of the selected level.
```
webtinkle [command] -L
```
The available log levels are enumerated below. You can use their name or their level id as argument. Logs with lower or equal levels than the choosen log level will be printed in the console.
* error (0)
* warn (1)
* info (2)
* verbose (3)
* debug (4)
* silly (5)