{"id":24813525,"url":"https://github.com/gokul656/obscure-fs","last_synced_at":"2026-05-10T09:39:26.896Z","repository":{"id":273117957,"uuid":"918706641","full_name":"gokul656/obscure-fs","owner":"gokul656","description":"Decentralized file-sharing network built using LibP2P","archived":false,"fork":false,"pushed_at":"2025-01-30T11:38:34.000Z","size":21339,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T12:28:49.698Z","etag":null,"topics":["decentralized","golang","ipfs","libp2p"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gokul656.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":"2025-01-18T16:41:34.000Z","updated_at":"2025-01-30T11:38:37.000Z","dependencies_parsed_at":"2025-01-19T12:59:28.799Z","dependency_job_id":null,"html_url":"https://github.com/gokul656/obscure-fs","commit_stats":null,"previous_names":["gokul656/obscure-fs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokul656%2Fobscure-fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokul656%2Fobscure-fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokul656%2Fobscure-fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gokul656%2Fobscure-fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gokul656","download_url":"https://codeload.github.com/gokul656/obscure-fs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245509246,"owners_count":20626941,"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":["decentralized","golang","ipfs","libp2p"],"created_at":"2025-01-30T15:26:06.307Z","updated_at":"2026-05-10T09:39:26.848Z","avatar_url":"https://github.com/gokul656.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ObscureFS\n\nThis project is a decentralized file-sharing network built using LibP2P. It allows nodes to share and retrieve files, discover other peers, and list available files for download.\n\n## Features\n- **File Sharing**: Share files using unique CIDs (Content Identifiers).\n- **File Retrieval**: Retrieve files by their CIDs from the network.\n- **File Listing**: List all files available on a node.\n- **Peer-to-Peer Networking**: Connect to other peers using the LibP2P stack.\n- **Custom Protocols**: Support for `list_files` and CID-based file retrieval commands.\n\n## Getting Started\n\n### Prerequisites\n- Go 1.18+\n- Git\n- OpenSSL\n\n\n### Clone the Repository\n```bash\ngit clone https://github.com/gokul656/obscure-fs.git\ncd obscure-fs\n```\n\n### Generate Private Key\n\nUse the following command to generate a private key before starting the node:\n\n```bash\nopenssl genpkey -algorithm RSA -out keys/private-key.pem -pkeyopt rsa_keygen_bits:2048\n```\n\n### Build the Project\n```bash\nmake build\n```\nThis generates the `obscure-fs` binary in the project directory.\n\n### Run the Node\n```bash\n./obscure-fs serve --port \u003cnode-port\u003e --api-port \u003capi-port\u003e --pkey \u003cprivate-key\u003e\n```\n- `--port`: Port for the LibP2P network.\n- `--api-port`: Port for the HTTP API.\n- `--pkey`: Private key for peer\n\nExample:\n```bash\n./obscure-fs serve --port 3000 --api-port 8080 --pkey keys/private-key.pem\n```\n\n## Custom Protocols\n\n### 1. **list_files**\n- Command: `list_files`\n- Description: Returns a JSON-encoded list of files available on the node.\n\n### 2. **Retrieve by CID**\n- Command: `\u003cCID\u003e`\n- Description: Retrieves a file corresponding to the CID.\n\n## License\nThis project is licensed under the GNU Affero General Public License v3.0. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n- [LibP2P](https://libp2p.io/)\n- [Go](https://golang.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgokul656%2Fobscure-fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgokul656%2Fobscure-fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgokul656%2Fobscure-fs/lists"}