{"id":18882285,"url":"https://github.com/otto-aa/solid-local-pod","last_synced_at":"2025-07-22T17:36:26.366Z","repository":{"id":39898167,"uuid":"219169850","full_name":"Otto-AA/solid-local-pod","owner":"Otto-AA","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-11T11:48:12.000Z","size":46,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-31T03:42:39.787Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/Otto-AA.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":"2019-11-02T15:01:50.000Z","updated_at":"2020-09-12T10:20:55.000Z","dependencies_parsed_at":"2023-01-26T22:31:38.566Z","dependency_job_id":null,"html_url":"https://github.com/Otto-AA/solid-local-pod","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Otto-AA%2Fsolid-local-pod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Otto-AA%2Fsolid-local-pod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Otto-AA%2Fsolid-local-pod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Otto-AA%2Fsolid-local-pod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Otto-AA","download_url":"https://codeload.github.com/Otto-AA/solid-local-pod/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239850432,"owners_count":19707349,"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":[],"created_at":"2024-11-08T06:55:08.720Z","updated_at":"2025-02-20T14:04:32.283Z","avatar_url":"https://github.com/Otto-AA.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Solid Local Pod\n\nA nodejs library which can be used for running a solid pod over localhost.\n\n## Install\n\n```sh\nnpm install solid-local-pod\n```\n\n## Usage Example\n\nThis setup will serve the contents from the `/home/user/test` folder at https://localhost:3000. (Due to the automatic ssl certificate generation, you will likely need to accept the security risks in your browser, before being able to use it)\n\n```javascript\nconst httpsLocalhost = require(\"https-localhost\")()\nconst LocalPod = require('solid-local-pod')\n// Note: You could use solid-auth-cli or any other fetch which works in nodejs\nconst solidFileFetch = require('solid-local-pod/src/solidFileFetch')\n\nasync function main() {\n    // Note: If no certs are provided, it will run on http://localhost:${port}, else https://localhost${port}\n    const certs = await httpsLocalhost.getCerts()\n\n    const pod = new LocalPod({\n        port: 3000,\n        basePath: '/home/user/test',\n        certs,\n        fetch: solidFileFetch\n    })\n\n    pod.startListening()\n}\nmain()\n```\n\nYou can also take a look at [solid-local-pod-manager](https://github.com/Otto-AA/solid-local-pod-manager) which uses this library.\n\n## Configuration\n\n| Param        | Type           | Description  |\n| ------------- |:-------------:|:-----|\n| fetch        | (url, options) =\u003e Response | Similar to window.fetch. (e.g. solid-auth-cli or solid-local-pod/src/solidFileFetch) |\n| port         | number      |   A free port |\n| basePath | string      | This will be the root of the solid pod |\n| prefix | [string]      | (Optional) Will be prepend to the request path |\n| certs | [?] | (Optional) Certificates used for https\n\n## Methods\n\n| Name        |  Description  |\n|:------------- |:-----|\n| startListening        | Starts the localhost server |\n| stopListening         | Stops the localhost server |\n| isListening           | Returns true if server is active |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fotto-aa%2Fsolid-local-pod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fotto-aa%2Fsolid-local-pod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fotto-aa%2Fsolid-local-pod/lists"}