{"id":15527164,"url":"https://github.com/webtinkle/webtinkle","last_synced_at":"2026-01-24T04:02:39.988Z","repository":{"id":33884497,"uuid":"163296972","full_name":"webtinkle/webtinkle","owner":"webtinkle","description":"NGINX configuration generator tool","archived":false,"fork":false,"pushed_at":"2022-12-06T19:29:01.000Z","size":503,"stargazers_count":3,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-12T12:43:07.108Z","etag":null,"topics":["nginx","nginx-configuration"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webtinkle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-27T13:19:40.000Z","updated_at":"2020-08-13T14:01:34.000Z","dependencies_parsed_at":"2023-01-15T03:09:21.021Z","dependency_job_id":null,"html_url":"https://github.com/webtinkle/webtinkle","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtinkle%2Fwebtinkle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtinkle%2Fwebtinkle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtinkle%2Fwebtinkle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtinkle%2Fwebtinkle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webtinkle","download_url":"https://codeload.github.com/webtinkle/webtinkle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250412544,"owners_count":21426285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nginx","nginx-configuration"],"created_at":"2024-10-02T11:04:48.351Z","updated_at":"2026-01-24T04:02:39.921Z","avatar_url":"https://github.com/webtinkle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebTinkle\nNGINX configuration generator tool\n\n\u003e /!\\ Currently, WebTinkle is in an early stage and must not be used in production /!\\\n\n## Install\nWebTinkle depends on NodeJS 6.4.0 or later and can be installed with npm (generally bundled with NodeJS) using this command:\n```bash\nnpm i -g webtinkle\n```\n\n## How to use\n\n### Templates\nThe most important part of WebTinkle is templating. Templates allows to make an NGINX configuration adapted to the needs.\nWebTinkle 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:\n```bash\nwebtinkle install \u003ctemplateName\u003e\n```\nIt will download the specified template from [this GitHub repository](https://github.com/webtinkle/webtinkle-templates) and install those automatically.\n\nIf you want to remove an installed template, use [`webtinkle uninstall`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-uninstall)  command:\n```bash\nwebtinkle uninstall \u003ctemplateName\u003e\n```\n\n### Website\n\nTo add a website to NGINX configs, use the [`webtinkle add`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-add) command:\n```bash\nwebtinkle add \u003cdomain\u003e -t \u003ctemplateName\u003e\n```\n\nTo remove a website from NGINX configs, use the [`webtinkle remove`](https://github.com/webtinkle/webtinkle/wiki/Command:-webtinkle-remove) command:\n```bash\nwebtinkle remove \u003cdomain\u003e\n```\n\n\n## Troubleshooting\n### nginx.configFolder must point to a directory\nIt means that your NGINX configuration path is not a valid folder.\nnginx.configFolder must point to a path where he would be able to put the NGINX configurations.\nIn most computers, this folder is located at `/etc/nginx/conf.d/`, but sometimes, it must point to a different folder.\n\nTo change the location where WebTinkle put its configurations, you must do the command:\n```\nwebtinkle config nginx.configFolder \u003cyourPath\u003e\n```\n\n\n\n## Contribute\n### Getting Started\nFirst, WebTinkle requires yarn to handle its dependencies, so make sure you have it to avoid trouble.\n\nTo start, you need to clone the repository. When you've done this, install all dependencies using the command below:\n```bash\nyarn\n```\nIt should load all dependencies. After that you can contribute.\n\n\n### Build Project\nGulp 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.\n#### Developement Build\nDevelopement build are builds made to be built faster and to provide more informations to developers.\n```bash\ngulp dev\n```\n#### Production Build\nProduction build are build made to be more optimized for a publication.\n```bash\ngulp prod\n```\n\n### Execute Commands\nWebTinkle provides a script to test the commands, to use it, instead of using `webtinkle` at the start of your commands, use the following:\n```bash\nyarn cli ...\n```\n\nFor example, `webtinkle install proxy` becomes `yarn cli install proxy`.\n\n### Show Logs\nWebTinkle has a command option named `--loglevel`, or simply `-L`. It can be used to provide more or less logs depending of the selected level.\n```\nwebtinkle [command] -L \u003clevel\u003e\n```\n\nThe 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.\n* error (0)\n* warn (1)\n* info (2)\n* verbose (3)\n* debug (4)\n* silly (5)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtinkle%2Fwebtinkle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebtinkle%2Fwebtinkle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtinkle%2Fwebtinkle/lists"}