{"id":28240094,"url":"https://github.com/codefeathers/up-serve","last_synced_at":"2025-06-11T21:30:30.061Z","repository":{"id":57387041,"uuid":"108629844","full_name":"codefeathers/up-serve","owner":"codefeathers","description":"A cli tool to quickly create and manage nginx server blocks.","archived":false,"fork":false,"pushed_at":"2018-10-07T11:02:22.000Z","size":2545,"stargazers_count":18,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-19T03:12:37.163Z","etag":null,"topics":["automation","configuration","javascript","nginx","server","up-serve"],"latest_commit_sha":null,"homepage":"https://up.js.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codefeathers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.MD","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-28T07:42:35.000Z","updated_at":"2023-08-26T07:02:16.000Z","dependencies_parsed_at":"2022-08-31T04:11:48.068Z","dependency_job_id":null,"html_url":"https://github.com/codefeathers/up-serve","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/codefeathers/up-serve","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codefeathers%2Fup-serve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codefeathers%2Fup-serve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codefeathers%2Fup-serve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codefeathers%2Fup-serve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codefeathers","download_url":"https://codeload.github.com/codefeathers/up-serve/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codefeathers%2Fup-serve/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259345440,"owners_count":22843530,"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":["automation","configuration","javascript","nginx","server","up-serve"],"created_at":"2025-05-19T03:12:37.151Z","updated_at":"2025-06-11T21:30:30.055Z","avatar_url":"https://github.com/codefeathers.png","language":"JavaScript","readme":"\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\r\n\r\n\u003cp alt=\"up—quick server blocks in one command\" align=\"center\"\u003e\u003cimg height=\"80\"src=\"assets/icon.png\"\u003e\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003equick \u003cem\u003enginx\u003c/em\u003e server blocks in one command\u003c/p\u003e\r\n\r\n\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\r\n\r\n# up\r\n\r\n![A quick demo](assets/demo.gif)\r\n\r\n\u003e Current version: `up v.0.3.1 (Alpha)`\r\n\r\n\u003e Notes: `up` is now in Alpha! 🎉 [(Changelog)](/docs/Changelog.md)\\\r\n\u003e ⚠️ `up` is pretty useable so far. If you're testing `up` on a development server, do give us feedback.\r\n\r\n**`up`** is a command line application that creates nginx server blocks quickly with a single command.\r\n\r\n\r\n## Installation\r\n\r\n`up` currently supports nginx mainline and nginx stable on Linux based distros. Support for more distros will come soon. Add an issue to bump this process. \r\n\r\nYou will need to have [_node JS_](https://nodejs.org) and [_nginx_](https://nginx.org) installed.\r\n\r\nInstall `up` from npm:\r\n\r\n`npm i -g up-serve`\r\n\r\n\u003e `up` is now available as a command.\r\n\r\n## Basic Commands\r\n\r\nFormat: `up command \u003crequired\u003e [optional]`\r\n\r\n- `up serve \u003cdomain\u003e [outbound port]` - Create new static server at current folder.\r\n\t- `up static` is deprecated from `v. 0.2.5` (see [changelog](/docs/CHANGELOG.md))\r\n- `up proxy \u003cdomain\u003e \u003cinbound port\u003e [outbound port]` - Create new proxy server listening at said port.\r\n- `up list` - List currently available servers.\r\n- `up kill \u003cdomain\u003e` - Kill the server for this domain.\r\n\r\n## Examples\r\n\r\n- `up serve example.com` will serve a static website from current folder.\r\n- `up proxy example.com 8081` will create a reverse proxy listening at port 8081.\r\n- `up kill example.com` will kill the server named example.com.\r\n- `up list` will fetch a list of servers created with `up`.\r\n\r\n## API\r\n\r\n```JavaScript\r\nconst up = require('up-serve')\r\n\r\nconsole.log(up.version()) // up v. 0.3.0\r\n\r\nlet result = up.server({ domain: \"example.com\", path: \"path/to/project\", outPort: \"80\" })\r\nconsole.log(result) // Will log success or throw if error\r\n\r\nlet result = up.kill({ domain: \"example.com\", outPort: \"80\" })\r\nconsole.log(result) // Will log success or throw if error\r\n```\r\n\r\nMore detailed API documentation coming soon.\r\n\r\n---\r\n\r\n\u003ch2 align=\"center\"\u003eMeta\u003c/h2\u003e\r\n\r\n\u003ch4 align=\"center\"\u003e\u003ca href=\"/docs/Roadmap.MD\"\u003eRoadmap\u003c/a\u003e\u003c/h4\u003e\r\n\r\n\u003ch4 align=\"center\"\u003e\u003ca href=\"Contributing.MD\"\u003eContribution Guidelines\u003c/a\u003e\u003c/h4\u003e\r\n\r\n\u003ch4 align=\"center\"\u003e\u003ca href=\"/docs/Contributors.md\"\u003eContributors, Collaborators, and Guides\u003c/a\u003e\u003c/h4\u003e\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodefeathers%2Fup-serve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodefeathers%2Fup-serve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodefeathers%2Fup-serve/lists"}