Sign inSign up

olizilla/test-go-ipfs

By olizilla

•Updated over 6 years ago

testing dockerhub config

Image
0

373

olizilla/test-go-ipfs repository overview

⁠go-ipfs

banner

standard-readme compliant GoDoc Build Status

⁠What is IPFS?

IPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single bittorrent swarm, exchanging git objects. IPFS provides an interface as simple as the HTTP web, but with permanence built in. You can also mount the world at /ipfs.

For more info see: https://github.com/ipfs/ipfs⁠.

Please put all issues regarding:

⁠Table of Contents

⁠Security Issues

The 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!

If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to [email protected]⁠. Please DO NOT file a public issue. The GPG key for [email protected]⁠ is 4B9665FB 92636D17 7C7A86D3 50AAE8A9 59B13AF3⁠.

If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly.

⁠Install

The canonical download instructions for IPFS are over at: https://docs.ipfs.io/introduction/install/⁠. It is highly suggested you follow those instructions if you are not interested in working on IPFS development.

⁠System Requirements

IPFS can run on most Linux, macOS, and Windows systems. We recommend running it on a machine with at least 2 GB of RAM (it’ll do fine with only one CPU core), but it should run fine with as little as 1 GB of RAM. On systems with less memory, it may not be completely stable.

⁠Install prebuilt packages

We host prebuilt binaries over at our distributions page⁠.

From there:

  • Click the blue "Download go-ipfs" on the right side of the page.
  • Open/extract the archive.
  • Move ipfs to your path (install.sh can do it for you).

You can also download go-ipfs from this project's GitHub releases page if you are unable to access ipfs.io.

⁠From Linux package managers
⁠Arch Linux

In Arch Linux go-ipfs is available as go-ipfs⁠ package.

$ sudo pacman -S go-ipfs

Development version of go-ipfs is also on AUR under go-ipfs-git⁠. You can install it using your favourite AUR Helper or manually from AUR.

⁠Nix

For Linux and MacOSX you can use the purely functional package manager Nix⁠:

$ nix-env -i ipfs

You can also install the Package by using it's attribute name, which is also ipfs.

⁠Guix

GNU's functional package manager, Guix⁠, also provides a go-ipfs package:

$ guix package -i go-ipfs
⁠Snap

With snap, in any of the supported Linux distributions⁠:

$ sudo snap install ipfs
⁠Build from Source
⁠Install Go

The build process for ipfs requires Go 1.11 or higher. If you don't have it: Download Go 1.11+⁠.

You'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:

export PATH=$PATH:/usr/local/go/bin
export PATH=$PATH:$GOPATH/bin

(If you run into trouble, see the Go install instructions⁠).

⁠Download and Compile IPFS
$ go get -u -d github.com/ipfs/go-ipfs

$ cd $GOPATH/src/github.com/ipfs/go-ipfs
$ make install

If you are building on FreeBSD instead of make install use gmake install.

⁠Building on less common systems

If your operating system isn't officially supported, but you still want to try building ipfs anyways (it should work fine in most cases), you can do the following instead of make install:

$ make install_unsupported

Note: This process may break if gx⁠ (used for dependency management) or any of its dependencies break as go get will always select the latest code for every dependency, often resulting in mismatched APIs.

⁠Troubleshooting
⁠Updating go-ipfs
⁠Using ipfs-update

IPFS has an updating tool that can be accessed through ipfs update. The tool is not installed alongside IPFS in order to keep that logic independent of the main codebase. To install ipfs update, download it here⁠.

⁠Downloading IPFS builds using IPFS

List the available versions of go-ipfs:

$ ipfs cat /ipns/dist.ipfs.io/go-ipfs/versions

Then, to view available builds for a version from the previous command ($VERSION):

$ ipfs ls /ipns/dist.ipfs.io/go-ipfs/$VERSION

To download a given build of a version:

$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-386.tar.gz # darwin 32-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-amd64.tar.gz # darwin 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_freebsd-amd64.tar.gz # freebsd 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-386.tar.gz # linux 32-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-amd64.tar.gz # linux 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz # linux arm build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build

⁠Usage

  ipfs - Global p2p merkle-dag filesystem.

  ipfs [<flags>] <command> [<arg>] ...

SUBCOMMANDS
  BASIC COMMANDS
    init          Initialize ipfs local configuration
    add <path>    Add a file to ipfs
    cat <ref>     Show ipfs object data
    get <ref>     Download ipfs objects
    ls <ref>      List links from an object
    refs <ref>    List hashes of links from an object

  DATA STRUCTURE COMMANDS
    block         Interact with raw blocks in the datastore
    object        Interact with raw dag nodes
    files         Interact with objects as if they were a unix filesystem

  ADVANCED COMMANDS
    daemon        Start a long-running daemon process
    mount         Mount an ipfs read-only mountpoint
    resolve       Resolve any type of name
    name          Publish or resolve IPNS names
    dns           Resolve DNS links
    pin           Pin objects to local storage
    repo          Manipulate an IPFS repository

  NETWORK COMMANDS
    id            Show info about ipfs peers
    bootstrap     Add or remove bootstrap peers
    swarm         Manage connections to the p2p network
    dht           Query the DHT for values or peers
    ping          Measure the latency of a connection
    diag          Print diagnostics

  TOOL COMMANDS
    config        Manage configuration
    version       Show ipfs version information
    update        Download and apply go-ipfs updates
    commands      List all available commands

  Use 'ipfs <command> --help' to learn more about each command.

  ipfs uses a repository in the local file system. By default, the repo is located
  at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:

    export IPFS_PATH=/path/to/ipfsrepo

⁠Getting Started

See also: http://ipfs.io/docs/getting-started/⁠

To start using IPFS, you must first initialize IPFS's config files on your system, this is done with ipfs init. See ipfs init --help for information on the optional arguments it takes. After initialization is complete, you can use ipfs mount, ipfs add and any of the other commands to explore!

⁠Some things to try

Basic proof of 'ipfs working' locally:

echo "hello world" > hello
ipfs add hello
# This should output a hash string that looks something like:
# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
ipfs cat <that hash>
⁠Docker usage

An IPFS docker image is hosted at hub.docker.com/r/ipfs/go-ipfs⁠. To make files visible inside the container you need to mount a host directory with the -v option to docker. Choose a directory that you want to use to import/export files from IPFS. You should also choose a directory to store IPFS files that will persist when you restart the container.

export ipfs_staging=</absolute/path/to/somewhere/>
export ipfs_data=</absolute/path/to/somewhere_else/>

Start a container running ipfs and expose ports 4001, 5001 and 8080:

docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest

Watch the ipfs log:

docker logs -f ipfs_host

Wait for ipfs to start. ipfs is running when you see:

Gateway (readonly) server
listening on /ip4/0.0.0.0/tcp/8080

You can now stop watching the log.

Run ipfs commands:

docker exec ipfs_host ipfs <args...>

For example: connect to peers

docker exec ipfs_host ipfs swarm peers

Add files:

cp -r <something> $ipfs_staging
docker exec ipfs_host ipfs add -r /export/<something>

Stop the running container:

docker stop ipfs_host

When starting a container running ipfs for the first time with an empty data directory, it will call ipfs init to initialize configuration files and generate a new keypair. At this time, you can choose which profile to apply using the IPFS_PROFILE environment variable:

docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/go-ipfs:latest
⁠Troubleshooting

If you have previously installed IPFS before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your IPFS config directory (~/.ipfs by default) and rerunning ipfs init. This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries.

Please direct general questions and help requests to our forum⁠ or our IRC channel (freenode #ipfs).

If you believe you've found a bug, check the issues list⁠ and, if you don't see your problem there, either come talk to us on IRC (freenode #ipfs) or file an issue of your own!

⁠Packages

This table is generated using the module package-table⁠ with package-table --data=package-list.json.

Listing of the main packages used in the IPFS ecosystem. There are also three specifications worth linking here:

NameCI/TravisCoverageDescription
Files
go-unixfs⁠Travis CIcodecovthe core 'filesystem' logic
go-mfs⁠Travis CIcodecova mutable filesystem editor for unixfs
go-ipfs-posinfo⁠Travis CIcodecovhelper datatypes for the filestore
go-ipfs-chunker⁠Travis CIcodecovfile chunkers
Exchange
go-ipfs-exchange-interface⁠Travis CIcodecovexchange service interface
go-ipfs-exchange-offline⁠Travis CIcodecov(dummy) offline implementation of the exchange service
go-bitswap⁠Travis CIcodecovbitswap protocol implementation
go-blockservice⁠Travis CIcodecovservice that plugs a blockstore and an exchange together
Datastores
go-datastore⁠Travis CIcodecovdatastore interfaces, adapters, and basic implementations
go-ipfs-ds-help⁠Travis CIcodecovdatastore utility functions
go-ds-flatfs⁠Travis CIcodecova filesystem-based datastore
go-ds-measure⁠Travis CIcodecova metric-collecting database adapter
go-ds-leveldb⁠Travis CIcodecova leveldb based datastore
go-ds-badger⁠Travis CIcodecova badgerdb based datastore
Namesys
go-ipns⁠Travis CIcodecovIPNS datastructures and validation logic
Repo
go-ipfs-config⁠Travis CIcodecovgo-ipfs config file definitions
go-fs-lock⁠Travis CIcodecovlockfile management functions
fs-repo-migrations⁠Travis CIcodecovrepo migrations
Blocks
go-block-format⁠Travis CIcodecovblock interfaces and implementations
go-ipfs-blockstore⁠Travis CIcodecovblockstore interfaces and implementations
Commands
go-ipfs-cmds⁠Travis CIcodecovCLI & HTTP commands library
go-ipfs-cmdkit⁠Travis CIcodecovhelper types for the commands library
go-ipfs-api⁠Travis CIcodecova shell for the IPFS HTTP API
Metrics & Logging
go-metrics-interface⁠Travis CIcodecovmetrics collection interfaces
go-metrics-prometheus⁠Travis CIcodecovprometheus-backed metrics collector
go-log⁠Travis CIcodecovlogging framework
Generics/Utils
go-ipfs-routing⁠Travis CIcodecovrouting (content, peer, value) helpers
go-ipfs-util⁠Travis CIcodecovthe kitchen sink
go-ipfs-addr⁠Travis CIcodecovutility functions for parsing IPFS multiaddrs

For brevity, we've omitted go-libp2p and go-ipld packages. These package tables can be found in their respective project's READMEs:

⁠Development

Some places to get you started on the codebase:

⁠CLI, HTTP-AP

Tag summary

Content type

Image

Digest

Size

28.9 MB

Last updated

over 6 years ago

docker pull olizilla/test-go-ipfs:bifrost-latest