8.2 KiB

Executable File

Czysty Wina Historia

linuxserver/ipfs

Ipfs - A peer-to-peer hypermedia protocol designed to make the web faster, safer, and more open.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling linuxserver/ipfs should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Tag
x86-64	amd64-latest
arm64	arm64v8-latest
armhf	arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
  --name=ipfs \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 80:80 \
  -p 4001:4001 \
  -p 5001:5001 \
  -p 8080:8080 \
  -p 443:443 `#optional` \
  -v /path/to/data:/config \
  --restart unless-stopped \
  linuxserver/ipfs

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  ipfs:
    image: linuxserver/ipfs
    container_name: ipfs
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/data:/config
    ports:
      - 80:80
      - 4001:4001
      - 5001:5001
      - 8080:8080
    ports:
      - 443:443 #optional
    restart: unless-stopped

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (`-p`)

Parameter	Function
`80`	The port for the IPFS web UI
`4001`	Peering port, this is the only port you should expose to the internet
`5001`	API port, the clientside webUI needs to be able to talk to this from whatever machine your web browser is on
`8080`	Gateway Port, actually serves IPFS content
`443`	HTTPS port for web UI

Environment Variables (`-e`)

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Europe/London`	Specify a timezone to use EG Europe/London

Volume Mappings (`-v`)

Volume	Function
`/config`	IPFS storage and config files/logs

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

In order to push files beyond your local gateway you have to make sure port 4001 is forwarded to the internet. This is required for IPFS peers to reach in and grab your files so public gateways can serve them.

Access the webui at http://localhost , if not using localhost scroll to the bottom of the page and set the API Address setting to IE http://192.168.1.10:5001 , from there you can upload and manage files you push to IPFS. Your gateway to access IPFS files is http://localhost:8080/ipfs/YOUR-FILE-HASH-HERE . You can also simply use public IPFS gateways like:

Cloudflare - https://cloudflare-ipfs.com/ipfs/YOUR-FILE-HASH-HERE
IPFS.io - https://ipfs.io/ipfs/YOUR-FILE-HASH-HERE
Eternum.io - https://ipfs.eternum.io/ipfs/YOUR-FILE-HASH-HERE

Cloudflare is a solid option as they actually edge cache the files on their CDN so even if your node pinning the item goes down for periods of time their cache will last up to a month.

For more on using IPFS please read the docs here

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.

Support Info

Shell access whilst the container is running:
- docker exec -it ipfs /bin/bash
To monitor the logs of the container in realtime:
- docker logs -f ipfs
Container version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' ipfs
Image version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ipfs

Versions

09.07.19: - Initial version.

8.2 KiB Executable File Czysty Wina Historia