{"id":21434398,"url":"https://github.com/serguun42/zip-downloader","last_synced_at":"2025-03-16T22:46:41.545Z","repository":{"id":128965941,"uuid":"484257259","full_name":"serguun42/zip-downloader","owner":"serguun42","description":"Make a server to download local folders as zip.","archived":false,"fork":false,"pushed_at":"2024-01-25T19:26:48.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T09:11:31.673Z","etag":null,"topics":["archiver","zip"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serguun42.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-22T01:30:55.000Z","updated_at":"2022-04-22T01:33:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb273e32-84d9-4daf-afda-1882d6252039","html_url":"https://github.com/serguun42/zip-downloader","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/serguun42%2Fzip-downloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fzip-downloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fzip-downloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fzip-downloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serguun42","download_url":"https://codeload.github.com/serguun42/zip-downloader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243945529,"owners_count":20372894,"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":["archiver","zip"],"created_at":"2024-11-22T23:35:38.887Z","updated_at":"2025-03-16T22:46:41.521Z","avatar_url":"https://github.com/serguun42.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zip-downloader\n\nMake a server to download local folders as zip.\n\nUsed as extension for [Pretty Autoindex](https://github.com/serguun42/zip-downloader) – standalone Node.js addition to refine autoindex pages in nginx.\n\n## Hot to\n\n1. Install [Node.js](https://nodejs.org/) – `npm` included\n2. Install necessary dependencies – `npm i --production`\n3. [Edit zip-downloader config file](#config) as you need\n4. Edit [pm2 config](./config/pm2.production.json) if necessary\n5. Start zip-downloader – `npm run production`\n\nLater you'll need only the last step to spin up server.\n\nTo stop zip-downloader run – `npm run stop` or `pm2 delete zip-downloader`.\n\n## Development\n\n1. Install all dependencies – `npm i`\n2. Edit [nodemon config](./config/nodemon.dev.json)\n3. Run in watch mode – `npm run dev`\n\n## Config\n\nMain config located at [`config/zip-downloader.json`](./config/zip-downloader.json).\nSee [Typescript Declaration File](./types/zipdownloaderconfig.d.ts) for it (same as content below).\n\n#### ZipDownloaderConfig\n\n| parameter | description                                                                                                                                                     | type                            | default     |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------- |\n| `port`    | Zip Downloader server's port.                                                                                                                                   | `number`                        | `80`        |\n| `host`    | Zip Downloader server's host.                                                                                                                                   | `string`                        | `\"0.0.0.0\"` |\n| `paths`   | Allowed paths to be zipped and sent (e.g.: with `\"paths\": [\"/mnt/shareable\", \"/opt/data\"]` everything under _/mnt/shareable_ and _/opt/data_ can be downloaded) | `string[]`                      | `[]`        |\n| `https`   | Use https serving instead of http. If not set, http applies.                                                                                                    | [`HTTPSOptions`](#httpsoptions) | `null`      |\n\n#### HTTPSOptions\n\nUse https serving instead of http. If not set, http applies.\n\n| parameter | description              | type     | default                           |\n| --------- | ------------------------ | -------- | --------------------------------- |\n| `cert`    | Path to certificate file | `string` | **Required** (if `https` enabled) |\n| `key`     | Path to key file         | `string` | **Required** (if `https` enabled) |\n\n### [BSL-1.0 License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserguun42%2Fzip-downloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserguun42%2Fzip-downloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserguun42%2Fzip-downloader/lists"}