{"id":37174555,"url":"https://github.com/cpg1111/go-ipfs","last_synced_at":"2026-01-14T20:23:40.201Z","repository":{"id":57581973,"uuid":"73210317","full_name":"cpg1111/go-ipfs","owner":"cpg1111","description":"IPFS implementation in go","archived":false,"fork":true,"pushed_at":"2016-11-08T08:50:57.000Z","size":37285,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-20T16:47:52.364Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/ipfs/ipfs","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"ipfs/kubo","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cpg1111.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2016-11-08T17:29:13.000Z","updated_at":"2016-11-08T17:29:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/cpg1111/go-ipfs","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/cpg1111/go-ipfs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpg1111%2Fgo-ipfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpg1111%2Fgo-ipfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpg1111%2Fgo-ipfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpg1111%2Fgo-ipfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cpg1111","download_url":"https://codeload.github.com/cpg1111/go-ipfs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpg1111%2Fgo-ipfs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28434429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T18:57:19.464Z","status":"ssl_error","status_checked_at":"2026-01-14T18:52:48.501Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-14T20:23:39.642Z","updated_at":"2026-01-14T20:23:40.190Z","avatar_url":"https://github.com/cpg1111.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-ipfs\n\n![banner](https://ipfs.io/ipfs/QmVk7srrwahXLNmcDYvyUEJptyoxpndnRa57YJ11L4jV26/ipfs.go.png)\n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![GoDoc](https://godoc.org/github.com/ipfs/go-ipfs?status.svg)](https://godoc.org/github.com/ipfs/go-ipfs)\n[![Build Status](https://travis-ci.org/ipfs/go-ipfs.svg?branch=master)](https://travis-ci.org/ipfs/go-ipfs)\n\n\u003e IPFS implementation in Go\n\nIPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from\nGit, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm,\nexchanging git objects. IPFS provides an interface as simple as the HTTP web, but\nwith permanence built in. You can also mount the world at /ipfs.\n\nFor more info see: https://github.com/ipfs/ipfs.\n\nPlease put all issues regarding IPFS _design_ in the\n[ipfs repo issues](https://github.com/ipfs/ipfs/issues).\nPlease put all issues regarding the Go IPFS _implementation_ in [this repo](https://github.com/ipfs/go-ipfs/issues).\n\n## Table of Contents\n\n- [Security Issues](#security-issues)\n- [Install](#install)\n  - [Install prebuilt packages](#install-prebuilt-packages)\n  - [Build from Source](#build-from-source)\n    - [Install Go](#install-go)\n    - [Download and Compile IPFS](#download-and-compile-ipfs)\n    - [Troubleshooting](#troubleshooting)\n  - [Development Dependencies](#development-dependencies)\n  - [Updating](#updating)\n- [Usage](#usage)\n- [Getting Started](#getting-started)\n  - [Some things to try](#some-things-to-try)\n  - [Docker usage](#docker-usage)\n  - [Troubleshooting](#troubleshooting-1)\n- [Todo](#todo)\n- [Contributing](#contributing)\n  - [Want to hack on IPFS?](#want-to-hack-on-ipfs)\n- [License](#license)\n\n## Security Issues\n\nThe IPFS protocol and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. And -- though IPFS is not production-ready yet -- many people are already running nodes in their machines. So we take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away!\n\nIf you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to security@ipfs.io. Please DO NOT file a public issue. The GPG key for security@ipfs.io is [4B9665FB 92636D17 7C7A86D3 50AAE8A9 59B13AF3](https://pgp.mit.edu/pks/lookup?op=get\u0026search=0x50AAE8A959B13AF3).\n\nIf the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly.\n\n## Install\n\nThe canonical download instructions for IPFS are over at: http://ipfs.io/docs/install/. It is **highly suggested** you follow those instructions if you are not interested in working on IPFS development.\n\n### Install prebuilt packages\n\nWe host prebuilt binaries over at our [distributions page](https://ipfs.io/ipns/dist.ipfs.io#go-ipfs).\n\nFrom there:\n- Click the blue \"Download go-ipfs\" on the right side of the page.\n- Open/extract the archive.\n- Move `ipfs` to your path (`install.sh` can do it for you).\n\n### Build from Source\n\n#### Install Go\n\nThe build process for ipfs requires Go 1.7 or higher. If you don't have it: [Download Go 1.7+](https://golang.org/dl/).\n\n\nYou'll need to add Go's bin directories to your `$PATH` environment variable e.g., by adding these lines to your `/etc/profile` (for a system-wide installation) or `$HOME/.profile`:\n\n```\nexport PATH=$PATH:/usr/local/go/bin\nexport PATH=$PATH:$GOPATH/bin\n```\n\n(If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)).\n\n#### Download and Compile IPFS\n\ngo-ipfs differs from the vanilla `go get` flow: it uses\n[gx](https://github.com/whyrusleeping/gx)/[gx-go](https://github.com/whyrusleeping/gx-go)\nfor dependency management.\n\nFirst download `go-ipfs` without installing:\n\n```\n$ go get -u -d github.com/ipfs/go-ipfs\n\n$ cd $GOPATH/src/github.com/ipfs/go-ipfs\n```\n\nThen install `go-ipfs` and its dependencies, including `gx` and `gx-go`:\n\n```\n$ make install\n```\n\n#### Building on less common systems\n\nIf your operating system isn't officially supported, but you still want to try\nbuilding ipfs anyways (it should work fine in most cases), you can do the\nfollowing:\n\n- Install gx: `go get -u github.com/whyrusleeping/gx`\n- Install gx-go: `go get -u github.com/whyrusleeping/gx-go`\n- Fetch ipfs source: `go get -d github.com/ipfs/go-ipfs 2\u003e /dev/null`\n- Enter source directory: `cd $GOPATH/src/github.com/ipfs/go-ipfs`\n- Install deps: `gx install`\n- Install ipfs: `go install ./cmd/ipfs`\n\nNote: This process may break if [gx](https://github.com/whyrusleeping/gx) or any of its dependencies break as `go get`\nwill always select the latest code for every dependency, often resulting in\nmismatched APIs.\n\n#### Troubleshooting\n\n* Separate [instructions are available for building on Windows](docs/windows.md).\n* `git` is required in order for `go get` to fetch all dependencies.\n* Package managers often contain out-of-date `golang` packages.\n  Ensure that `go version` reports at least 1.7. See above for how to install go.\n* If you are interested in development, please install the development\ndependencies as well.\n* *WARNING: Older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!*\n  We strongly recommend you use the [latest version of OSX FUSE](http://osxfuse.github.io/).\n  (See https://github.com/ipfs/go-ipfs/issues/177)\n* For more details on setting up FUSE (so that you can mount the filesystem), see the docs folder.\n* Shell command completion is available in `misc/completion/ipfs-completion.bash`. Read [docs/command-completion.md](docs/command-completion.md) to learn how to install it.\n* See the [init examples](https://github.com/ipfs/examples/tree/master/examples/init) for how to connect IPFS to systemd or whatever init system your distro uses.\n\n### Development Dependencies\n\nIf you make changes to the protocol buffers, you will need to install the [protoc compiler](https://github.com/google/protobuf).\n\n### Updating\n\nIPFS has an updating tool that can be accessed through `ipfs update`. The tool is\nnot installed alongside IPFS in order to keep that logic independent of the main\ncodebase. To install `ipfs update`, [download it here](https://ipfs.io/ipns/dist.ipfs.io/#ipfs-update).\n\n## Usage\n\n```\n  ipfs - Global p2p merkle-dag filesystem.\n\n  ipfs [\u003cflags\u003e] \u003ccommand\u003e [\u003carg\u003e] ...\n\nSUBCOMMANDS\n  BASIC COMMANDS\n    init          Initialize ipfs local configuration\n    add \u003cpath\u003e    Add a file to ipfs\n    cat \u003cref\u003e     Show ipfs object data\n    get \u003cref\u003e     Download ipfs objects\n    ls \u003cref\u003e      List links from an object\n    refs \u003cref\u003e    List hashes of links from an object\n\n  DATA STRUCTURE COMMANDS\n    block         Interact with raw blocks in the datastore\n    object        Interact with raw dag nodes\n    files         Interact with objects as if they were a unix filesystem\n\n  ADVANCED COMMANDS\n    daemon        Start a long-running daemon process\n    mount         Mount an ipfs read-only mountpoint\n    resolve       Resolve any type of name\n    name          Publish or resolve IPNS names\n    dns           Resolve DNS links\n    pin           Pin objects to local storage\n    repo          Manipulate an IPFS repository\n\n  NETWORK COMMANDS\n    id            Show info about ipfs peers\n    bootstrap     Add or remove bootstrap peers\n    swarm         Manage connections to the p2p network\n    dht           Query the DHT for values or peers\n    ping          Measure the latency of a connection\n    diag          Print diagnostics\n\n  TOOL COMMANDS\n    config        Manage configuration\n    version       Show ipfs version information\n    update        Download and apply go-ipfs updates\n    commands      List all available commands\n\n  Use 'ipfs \u003ccommand\u003e --help' to learn more about each command.\n\n  ipfs uses a repository in the local file system. By default, the repo is located\n  at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:\n\n    export IPFS_PATH=/path/to/ipfsrepo\n```\n\n## Getting Started\n\nSee also: http://ipfs.io/docs/getting-started/\n\nTo start using IPFS, you must first initialize IPFS's config files on your\nsystem, this is done with `ipfs init`. See `ipfs init --help` for information on\nthe optional arguments it takes. After initialization is complete, you can use\n`ipfs mount`, `ipfs add` and any of the other commands to explore!\n\n### Some things to try\n\nBasic proof of 'ipfs working' locally:\n\n\techo \"hello world\" \u003e hello\n\tipfs add hello\n\t# This should output a hash string that looks something like:\n\t# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o\n\tipfs cat \u003cthat hash\u003e\n\n\n### Docker usage\n\nAn IPFS docker image is hosted at [hub.docker.com/r/ipfs/go-ipfs](https://hub.docker.com/r/ipfs/go-ipfs/).\nTo make files visible inside the container you need to mount a host directory\nwith the `-v` option to docker. Choose a directory that you want to use to\nimport/export files from IPFS. You should also choose a directory to store\nIPFS files that will persist when you restart the container.\n\n    export ipfs_staging=\u003c/absolute/path/to/somewhere/\u003e\n    export ipfs_data=\u003c/absolute/path/to/somewhere_else/\u003e\n\nMake sure docker can access these folders:\n\n    sudo chmod -R 777 /absolute/path/to/somewhere/\n    sudo chmod -R 777 /absolute/path/to/somewhere_else/\n\nStart a container running ipfs and expose ports 4001, 5001 and 8080:\n\n    docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 8080:8080 -p 4001:4001 -p 5001:5001 ipfs/go-ipfs:latest\n\nWatch the ipfs log:\n\n    docker logs -f ipfs_host\n\nWait for ipfs to start. ipfs is running when you see:\n\n    Gateway (readonly) server\n    listening on /ip4/0.0.0.0/tcp/8080\n\nYou can now stop watching the log.\n\nRun ipfs commands:\n\n    docker exec ipfs_host ipfs \u003cargs...\u003e\n\nFor example: connect to peers\n\n    docker exec ipfs_host ipfs swarm peers\n\nAdd files:\n\n    cp -r \u003csomething\u003e $ipfs_staging\n    docker exec ipfs_host ipfs add -r /export/\u003csomething\u003e\n\nStop the running container:\n\n    docker stop ipfs_host\n\n### Troubleshooting\nIf you have previously installed IPFS before and you are running into\nproblems getting a newer version to work, try deleting (or backing up somewhere\nelse) your IPFS config directory (~/.ipfs by default) and rerunning `ipfs init`.\nThis will reinitialize the config file to its defaults and clear out the local\ndatastore of any bad entries.\n\nFor any other problems, check the [issues list](https://github.com/ipfs/go-ipfs/issues)\nand if you dont see your problem there, either come talk to us on irc (freenode #ipfs) or\nfile an issue of your own!\n\n## Todo\n\nAn IPFS alpha version has been released in February 2015. Things left to be done are all marked as [issues](https://github.com/ipfs/go-ipfs/issues).\n\n## Contributing\n\nPlease see [Contribute.md](contribute.md)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcpg1111%2Fgo-ipfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcpg1111%2Fgo-ipfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcpg1111%2Fgo-ipfs/lists"}