{"id":19294577,"url":"https://github.com/web3-storage/autobahn","last_synced_at":"2025-04-22T08:30:34.410Z","repository":{"id":169051879,"uuid":"644810259","full_name":"web3-storage/autobahn","owner":"web3-storage","description":"🛣️ Experimental IPFS HTTP gateway for UnixFS data via CARs.","archived":true,"fork":false,"pushed_at":"2023-06-19T16:27:47.000Z","size":93,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-24T00:28:04.774Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://dev.autobahn.dag.haus","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/web3-storage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-05-24T09:55:51.000Z","updated_at":"2024-04-18T16:16:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"0522fa73-0ec0-4b9d-afc7-1049ee285442","html_url":"https://github.com/web3-storage/autobahn","commit_stats":null,"previous_names":["web3-storage/autobahn"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3-storage%2Fautobahn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3-storage%2Fautobahn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3-storage%2Fautobahn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3-storage%2Fautobahn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/web3-storage","download_url":"https://codeload.github.com/web3-storage/autobahn/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250205976,"owners_count":21392158,"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-09T22:38:45.685Z","updated_at":"2025-04-22T08:30:34.404Z","avatar_url":"https://github.com/web3-storage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://bafybeicrttclnbsndlwv7p4ijzlsx7zzchkk3ahsc4slptfpwk73aicibe.ipfs.w3s.link/logo-autobahn.png\" width=\"150\" /\u003e\n  \u003ch1\u003eautobahn\u003c/h1\u003e\n\u003c/div\u003e\n\n🧪 Experimental Trustless IPFS HTTP gateway providing access to UnixFS data via CAR CIDs.\n\nHow it works:\n\n1. Extract `DATA_CID` from URL.\n1. Lookup block index information in DyanmoDB\n1. UnixFS export directly from S3 buckets using index data to locate block positions.\n\nThe search parameter `?origin` can optionally provide the hint of which CAR file(s) the data DAG is contained within. e.g.\n\n```\nhttps://autobahn.dag.haus/ipfs/bafybeiaaxqlnwlfeirgr5p63ftnfszmerttupnwrim52h4zv2tfpntbjdy/data.txt?origin=bagbaieralsmnkvhi3t3d7lek2ti2vhfglb4bhw7gite2qsz467zjuqvbvyva\n```\n\n[Read MOAR](READMOAR.md)\n\n## Getting Started\n\nThe repo contains the infra deployment code and the service implementation.\n\n```\n├── packages   - autobahn core and lambda wrapper\n└── stacks     - sst and aws cdk code to deploy all the things\n```\n\nTo work on this codebase **you need**:\n\n- Node.js \u003e= v18 (prod env is node v18)\n- An AWS account with the AWS CLI configured locally\n- Copy `.env.tpl` to `.env` and fill in the blanks\n- Install the deps with `npm i`\n\nDeploy dev services to your aws account and start dev console. You may need to provide a `--profile` to pick the aws profile to deploy with.\n\n```console\nnpm start\n```\n\nSee: https://docs.sst.dev for more info on how things get deployed.\n\n\n## Environment variables\n\nThe following should be set in the env when deploying. Copy `.env.tpl` to `.env` to set in dev.\n\n```sh\nSENTRY_DSN=\u003cyour error reporting key here\u003e\n\n# Name of the \"blocks-cars-position\" table in DynamoDB\nDYNAMO_TABLE=\u003ctable name here\u003e\n\n# Region of the DynamoDB to query\nDYNAMO_REGION=us-west-2\n\n# (optional) CSV of S3 regions of buckets that CAR files are stored in\nS3_REGIONS=us-east-1,us-east-2,us-west-2\n\n# (optional) route53 zone name and id for custom domain.\n# Create it in route53 and point NS records for it to route53 as needed.\nHOSTED_ZONE=autobahn.dag.haus\nHOSTED_ZONE_ID=Z09596441DFFYKDGRFNYN\n```\n\n## Contributing\n\nFeel free to join in. All welcome. Please read our [contributing guidelines](https://github.com/web3-storage/autobahn/blob/main/CONTRIBUTING.md) and/or [open an issue](https://github.com/web3-storage/autobahn/issues)!\n\n## License\n\nDual-licensed under [MIT + Apache 2.0](https://github.com/web3-storage/autobahn/blob/main/LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb3-storage%2Fautobahn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweb3-storage%2Fautobahn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb3-storage%2Fautobahn/lists"}