{"id":37673774,"url":"https://github.com/regmibijay/nginx-quickdeploy","last_synced_at":"2026-01-16T12:09:31.822Z","repository":{"id":57446055,"uuid":"395833023","full_name":"regmibijay/nginx-quickdeploy","owner":"regmibijay","description":"Quickly deploy websites with just URL name, generate letsencrypt certificates on the go  and create placeholder website.","archived":false,"fork":false,"pushed_at":"2024-01-13T08:39:20.000Z","size":50,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-31T22:30:56.098Z","etag":null,"topics":["deployment","nginx","webserver","website-development"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regmibijay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-13T23:57:31.000Z","updated_at":"2024-12-25T21:48:04.000Z","dependencies_parsed_at":"2022-09-26T17:30:30.349Z","dependency_job_id":null,"html_url":"https://github.com/regmibijay/nginx-quickdeploy","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/regmibijay/nginx-quickdeploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regmibijay%2Fnginx-quickdeploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regmibijay%2Fnginx-quickdeploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regmibijay%2Fnginx-quickdeploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regmibijay%2Fnginx-quickdeploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regmibijay","download_url":"https://codeload.github.com/regmibijay/nginx-quickdeploy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regmibijay%2Fnginx-quickdeploy/sbom","scorecard":{"id":768954,"data":{"date":"2025-08-11","repo":{"name":"github.com/regmibijay/nginx-quickdeploy","commit":"0a43298da02b786b5201b03fe70a9b19feb7656f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/27 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/regmibijay/nginx-quickdeploy/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/regmibijay/nginx-quickdeploy/main.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:23","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.4.0 not signed: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/48077288","Warn: release artifact v0.2.0 not signed: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/47851062","Warn: release artifact 0.1.0 not signed: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/47848399","Warn: release artifact 0.4.0 does not have provenance: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/48077288","Warn: release artifact v0.2.0 does not have provenance: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/47851062","Warn: release artifact 0.1.0 does not have provenance: https://api.github.com/repos/regmibijay/nginx-quickdeploy/releases/47848399"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T01:42:52.138Z","repository_id":57446055,"created_at":"2025-08-23T01:42:52.138Z","updated_at":"2025-08-23T01:42:52.138Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["deployment","nginx","webserver","website-development"],"created_at":"2026-01-16T12:09:31.741Z","updated_at":"2026-01-16T12:09:31.809Z","avatar_url":"https://github.com/regmibijay.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NGINX QUICKDEPLOY\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n![Build Workflow](https://github.com/regmibijay/nginx-quickdeploy/actions/workflows/main.yml/badge.svg)\n![PyPi Latest Release](https://img.shields.io/pypi/v/nginx-quickdeploy.svg)\n\n## About\n\nHelps you create and deploy websites on nginx quickly.\n\n## Installation\n\n`pip3 install nginx-quickdeploy`\n\n## Usage\n\n### Variables:\n\n- 'FQDN' : Fully Qualified Domain Name, name of your website\n- Nginx config path: Path where your generated config file is stored.\n- Ports: Ports to listen to, in format: `\u003cport1\u003e [ssl], \u003cport2\u003e [ssl]`\n- Root path: Path where your html files are located\n- Proxy: If your actual application is running on some other port, you can proxy pass and use nginx as webserver. For that just use this function, if not leave it empty\n- Hook : Post deployment shell script you want to be run\n\n### CLI\n\n```\n  -h, --help                          Show this help message and exit\n  -i [INPUT], --input [INPUT]         Input json file for easy installation\n  -d [DOMAIN], --domain [DOMAIN]      Domain you want to set up.\n  -p [PATH], --path [PATH]            Config file path\n  --ports [PORTS]                     Ports to listen to separated by comma(,)\n  -w [WEBROOT], --webroot [WEBROOT]   Webroot folder containing index.html\n  -f [FORWARD], --forward [FORWARD]   Proxy pass URL\n  --ssl_cert_path [SSL_CERT_PATH]     SSL certificate path\n  --ssl_key_path [SSL_KEY_PATH]       SSL key path\n  --hook                              Post install hook, a shell script you want to launch after\n                                      deployment is complete.\n```\n\n### JSON input:\n\nJson input is also supported for easier deployment. Following keys are supported:\n\n- url : mandatory : provide FQDN\n- path : optional : provide path to be written config, default /etc/nginx/sites-available/{URL}\n- ports : optional, list : provide ports to listen and with ssl or not, default 80 on both interfaces\n- root : optional : path to webroot folder, default /var/www/html/{url}\n- proxy : optional : path to http proxy if you have an app running behind nginx\n- ssl_cert_path : optional : SSL cert path if you have ssl enabled\n- ssl_key_path : optional : SSL key path if you have ssl enabled\n\n#### Json example\n\n```\n{\n  \"url\": \"www.example.org\",\n  \"path\": \"/usr/shared/www.example.org\",\n  \"ports\": [\"80\", \"[::]:80\", \"443 ssl\", \"[::]:443 ssl\"],\n  \"root\": \"/var/www/html\",\n  \"proxy\": \"https://app.example.org:8080\",\n  \"ssl_cert_path\": \"/etc/ssl/myexample.org/cert.crt\",\n  \"ssl_key_path\": \"/etc/ssl/myexample.org/key.pem\"\n}\n```\n\nyields:\n\n```\nserver {\nroot /var/www/html;\nindex index.html index.htm index.nginx-debian.html;\nserver_name www.example.org;\nlisten 80;\nlisten [::]:80;\nlisten 443 ssl;\nlisten [::]:443 ssl;\nssl_certificate /etc/ssl/myexample.org/cert.crt;\nssl_certificate_key /etc/ssl/myexample.org/key.pem;\nlocation / {\n  proxy_pass https://app.example.org:8080;\n  }\n}\n```\n\n## Tips and Examples\n\nInvoke the script with sudo rights if you want to write to `/etc/ngnix/sites-available` as it is write protected for non sudo users.\n\n`# sudo quickdeploy`\n\n```\nFQDN of your domain, e.g. example.com or subdomain.example.com without http or https:  www.example.org\nWhere should the new config file be saved?, default is /etc/nginx/sites-available/www.example.org :\nPorts separated by commas(,) in nginx fashion, like 80, [::]:80 etc\nFor ssl, just add ssl after the port, e.g. 80, 443 ssl, [::]:80, [::]:443 ssl\nEnter ports here:\nEnter the www root path(default /var/www/html):\nShould this server need to proxy_pass, enter the address here:\n\nYour new website was deployed successfully\nRestart nginx to serve it via nginx.\n```\n\nwould yield a config file that looks like this:\n\n```\nserver {\n  root /var/www/html;\n  server_name www.example.org;\n  listen 80;\n   location / {\n       try_files $uri $uri/;\n   }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregmibijay%2Fnginx-quickdeploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregmibijay%2Fnginx-quickdeploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregmibijay%2Fnginx-quickdeploy/lists"}