Merge pull request #9306 from ipfs/release-v0.16.0

release v0.16.0

.circleci/main.yml

@@ -37,7 +37,7 @@ default_environment: &default_environment
 executors:
   golang:
     docker:
-      - image: cimg/go:1.18.5
+      - image: cimg/go:1.19.1
     working_directory: ~/ipfs/kubo
     environment:
       <<: *default_environment
@@ -62,7 +62,7 @@ executors:
       E2E_IPFSD_TYPE: go
   dockerizer:
     docker:
-      - image: cimg/go:1.18.5
+      - image: cimg/go:1.19.1
     environment:
       IMAGE_NAME: ipfs/kubo
       WIP_IMAGE_TAG: wip
@@ -156,8 +156,8 @@ jobs:
     - run: sudo apt update
     - run: |
         mkdir ~/localgo && cd ~/localgo
-        wget https://golang.org/dl/go1.18.5.linux-amd64.tar.gz
-        tar xfz go1.18.5.linux-amd64.tar.gz
+        wget https://golang.org/dl/go1.19.1.linux-amd64.tar.gz
+        tar xfz go1.19.1.linux-amd64.tar.gz
         echo "export PATH=$(pwd)/go/bin:\$PATH" >> ~/.bashrc
     - run: go version
     - run: sudo apt install socat net-tools
@@ -223,7 +223,7 @@ jobs:
       - *store_gomod
   interop:
     docker:
-      - image: cimg/go:1.18.5-node
+      - image: cimg/go:1.19.1-node
     parallelism: 4
     resource_class: large
     steps:

.github/workflows/codeql-analysis.yml

@@ -31,12 +31,12 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
 
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/golang-analysis.yml

@@ -11,7 +11,7 @@ jobs:
           submodules: recursive
       - uses: actions/setup-go@v2
         with:
-          go-version: "1.18.x"
+          go-version: "1.19.x"
       - name: Check that go.mod is tidy
         uses: protocol/multiple-go-modules@v1.2
         with:
@@ -22,12 +22,13 @@ jobs:
               exit 1
             fi
             git diff --exit-code -- go.sum go.mod
-      - name: gofmt
+      - name: go fmt
         if: always() # run this step even if the previous one failed
         run: |
-          out=$(gofmt -s -l .)
+          out=$(go fmt ./...)
           if [[ -n "$out" ]]; then
-            echo $out | awk '{print "::error file=" $0 ",line=0,col=0::File is not gofmt-ed."}'
+            echo "Files are not go-fmt-ed:"
+            echo "$out"
             exit 1
           fi
       - name: go vet

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Kubo Changelogs
 
+- [v0.16](docs/changelogs/v0.16.md)
 - [v0.15](docs/changelogs/v0.15.md)
 - [v0.14](docs/changelogs/v0.14.md)
 - [v0.13](docs/changelogs/v0.13.md)

Dockerfile

@@ -1,5 +1,5 @@
 # Note: when updating the go minor version here, also update the go-channel in snap/snapcraft.yml
-FROM golang:1.18.5-buster
+FROM golang:1.19.1-buster
 LABEL maintainer="Steven Allen <steven@stebalien.com>"
 
 # Install deps
@@ -111,10 +111,10 @@ ENV IPFS_LOGGING ""
 # 2. The API and Gateway are accessible from outside the container.
 ENTRYPOINT ["/sbin/tini", "--", "/usr/local/bin/start_ipfs"]
 
-# Heathcheck for the container
+# Healthcheck for the container
 # QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn is the CID of empty folder
 HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
-  CMD ipfs dag stat /ipfs/QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn || exit 1 
+  CMD ipfs dag stat /ipfs/QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn || exit 1
 
 # Execute the daemon subcommand by default
 CMD ["daemon", "--migrate=true", "--agent-version-suffix=docker"]

README.md

@@ -1,6 +1,3 @@
-# kubo
-
-> the oldest IPFS implementation, previously known as "go-ipfs"
 
 ![kubo, an IPFS node in Go](https://ipfs.io/ipfs/bafykbzacecaesuqmivkauix25v6i6xxxsvsrtxknhgb5zak3xxsg2nb4dhs2u/ipfs.go.png)
 
@@ -10,15 +7,18 @@
 
 ## What is Kubo?
 
-Kubo (go-ipfs) the earliest and most widely used implementation of IPFS.
+Kubo was the first is the most widely used IPFS implementation today. Implementing the *Interplanetary Filesystem* - the Web3 standard and contender to replace https. Thus powered by IPLD's data models and the libp2p for network communication. Kubo is written in Go.
+
+Featureset
+- Runs an IPFS-Node as a network service
+- [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) to IPFS-Nodes
+- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme) 
+- HTTP RPC API (`/api/v0`) to access and control the daemon
+- IPFS's internal Webgui can be used to manage the Kubo nodes
 
-It includes:
-- an IPFS daemon server
-- extensive [command line tooling](https://docs.ipfs.tech/reference/kubo/cli/)
-- an [HTTP Gateway](https://github.com/ipfs/specs/tree/main/http-gateways#readme) (`/ipfs/`, `/ipns/`) for serving content to HTTP browsers
-- an HTTP RPC API (`/api/v0`) for controlling the daemon node
+### Other implementations
 
-Note: [other implementations exist](https://docs.ipfs.tech/basics/ipfs-implementations/).
+See [List](https://docs.ipfs.tech/basics/ipfs-implementations/)
 
 ## What is IPFS?
 
@@ -51,31 +51,30 @@ Before opening an issue, consider using one of the following locations to ensure
 - [Install](#install)
   - [System Requirements](#system-requirements)
   - [Docker](#docker)
-  - [Native Linux package managers](#native-linux-package-managers)
-    - [ArchLinux](#archlinux)
+  - [Official prebuilt binaries](#official-prebuilt-binaries)
+    - [Updating](#updating)
+      - [Using ipfs-update](#using-ipfs-update)
+      - [Downloading builds using IPFS](#downloading-builds-using-ipfs)
+  - [Unofficial Linux packages](#unofficial-linux-packages)
+    - [ArchLinux](#arch-linux)
     - [Nix](#nix)
     - [Solus](#solus)
     - [openSUSE](#opensuse)
-  - [Other package managers](#other-package-managers)
     - [Guix](#guix)
     - [Snap](#snap)
-    - [macOS package managers](#macos-package-managers)
+  - [Unofficial MacOS packages](#unofficial-macos-packages)
     - [MacPorts](#macports)
     - [Nix](#nix-1)
-    - [Homebrew](#homebrew)
-  - [Windows package managers](#windows-package-managers)
+    - [Homebrew](#homebrew)  
+  - [Unofficial Windows packages](#unofficial-windows-packages)
     - [Chocolatey](#chocolatey)
     - [Scoop](#scoop)
-  - [Install prebuilt binaries](#install-prebuilt-binaries)
   - [Build from Source](#build-from-source)
     - [Install Go](#install-go)
     - [Download and Compile IPFS](#download-and-compile-ipfs)
       - [Cross Compiling](#cross-compiling)
       - [OpenSSL](#openssl)
     - [Troubleshooting](#troubleshooting)
-  - [Updating](#updating)
-    - [Using ipfs-update](#using-ipfs-update)
-    - [Downloading builds using IPFS](#downloading-builds-using-ipfs)
 - [Getting Started](#getting-started)
   - [Usage](#usage)
   - [Some things to try](#some-things-to-try)
@@ -110,19 +109,67 @@ If your system is resource-constrained, we recommend:
 
 ### Docker
 
-[![Docker Image Version (legacy name)](https://img.shields.io/docker/v/ipfs/go-ipfs?color=blue&label=go-ipfs%20docker%20image&logo=docker&sort=semver&style=flat-square&cacheSeconds=3600)](https://hub.docker.com/r/ipfs/go-ipfs/)
-<!-- TODO: replace with kubo after we have minimum set of images after kubo 0.14 (stable semver release, 'latest' and 'release' docker tags)
+Official images are published at https://hub.docker.com/r/ipfs/kubo/:
+
 [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ipfs/kubo?color=blue&label=kubo%20docker%20image&logo=docker&sort=semver&style=flat-square&cacheSeconds=3600)](https://hub.docker.com/r/ipfs/kubo/)
--->
 
-More info on how to run kubo (go-ipfs) inside Docker can be found [here](https://docs.ipfs.tech/how-to/run-ipfs-inside-docker/).
+More info on how to run Kubo (go-ipfs) inside Docker can be found [here](https://docs.ipfs.tech/how-to/run-ipfs-inside-docker/).
+
+### Official prebuilt binaries
+
+The official binaries are published at https://dist.ipfs.tech#kubo:
+
+[![dist.ipfs.tech Downloads](https://img.shields.io/github/v/release/ipfs/kubo?label=dist.ipfs.tech&logo=ipfs&style=flat-square&cacheSeconds=3600)](https://dist.ipfs.tech#kubo)
+
+From there:
+- Click the blue "Download Kubo" on the right side of the page.
+- Open/extract the archive.
+- Move kubo (`ipfs`) to your path (`install.sh` can do it for you).
+
+If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo (go-ipfs) from:
+- this project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page
+- `/ipns/dist.ipfs.tech` at [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway
+
+#### Updating
+
+##### 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` tool, [download it here](https://dist.ipfs.tech/#ipfs-update).
+
+##### Downloading builds using IPFS
 
-### Native Linux package managers
+List the available versions of Kubo (go-ipfs) implementation:
+
+```console
+$ ipfs cat /ipns/dist.ipfs.tech/kubo/versions
+```
+
+Then, to view available builds for a version from the previous command (`$VERSION`):
+
+```console
+$ ipfs ls /ipns/dist.ipfs.tech/kubo/$VERSION
+```
+
+To download a given build of a version:
+
+```console
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_darwin-386.tar.gz    # darwin 32-bit build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_darwin-amd64.tar.gz  # darwin 64-bit build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_freebsd-amd64.tar.gz # freebsd 64-bit build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-386.tar.gz     # linux 32-bit build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-amd64.tar.gz   # linux 64-bit build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-arm.tar.gz     # linux arm build
+$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_windows-amd64.zip    # windows 64-bit build
+```
+
+### Unofficial Linux packages
 
 - [Arch Linux](#arch-linux)
 - [Nix](#nix-linux)
 - [Solus](#solus)
-- [openSUSE](#openSUSE)
+- [openSUSE](#opensuse)
 
 #### Arch Linux
 
@@ -159,11 +206,6 @@ You can also install it through the Solus software center.
 
 [Community Package for go-ipfs](https://software.opensuse.org/package/go-ipfs)
 
-### Other package managers
-
-- [Guix](#guix)
-- [Snap](#snap)
-
 #### Guix
 
 GNU's functional package manager, [Guix](https://www.gnu.org/software/guix/), also provides a go-ipfs package:
@@ -174,6 +216,11 @@ $ guix package -i go-ipfs
 
 #### Snap
 
+> ⚠️ **SNAP USE IS DISCOURAGED**
+> 
+> If you want something more sophisticated to escape the Snap confinement, we recommend using a different method to install Kubo so that it is not subject to snap confinement.
+
+
 With snap, in any of the [supported Linux distributions](https://snapcraft.io/docs/core/install):
 
 ```
@@ -186,14 +233,6 @@ The snap sets `IPFS_PATH` to `SNAP_USER_COMMON`, which is usually `~/snap/ipfs/c
 $ sudo mount --bind ~/.ipfs ~/snap/ipfs/common
 ```
 
-If you want something more sophisticated to escape the snap confinement, we recommend using a different method to install kubo so that it is not subject to snap confinement.
-
-#### macOS package managers
-
-- [MacPorts](#macports)
-- [Nix](#nix-macos)
-- [Homebrew](#Homebrew)
-
 #### MacPorts
 
 The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo (go-ipfs) and is being maintained.
@@ -220,7 +259,7 @@ A Homebrew formula [ipfs](https://formulae.brew.sh/formula/ipfs) is maintained t
 $ brew install --formula ipfs
 ```
 
-### Windows package managers
+### Unofficial Windows packages
 
 - [Chocolatey](#chocolatey)
 - [Scoop](#scoop)
@@ -230,7 +269,7 @@ $ brew install --formula ipfs
 [![Chocolatey Version](https://img.shields.io/chocolatey/v/go-ipfs?color=00a4ef&label=go-ipfs&logo=windows&style=flat-square&cacheSeconds=3600)](https://chocolatey.org/packages/go-ipfs)
 
 ```Powershell
-PS> choco install ipfs
+PS> choco install go-ipfs
 ```
 
 #### Scoop
@@ -242,18 +281,12 @@ PS> scoop bucket add extras
 PS> scoop install go-ipfs
 ```
 
-### Install prebuilt binaries
+### Unofficial macOS packages
 
-[![dist.ipfs.tech Downloads](https://img.shields.io/github/v/release/ipfs/kubo?label=dist.ipfs.tech&logo=ipfs&style=flat-square&cacheSeconds=3600)](https://dweb.link/ipns/dist.ipfs.tech#kubo)
-
-From there:
-- Click the blue "Download kubo" on the right side of the page.
-- Open/extract the archive.
-- Move kubo (`ipfs`) to your path (`install.sh` can do it for you).
+- [MacPorts](#macports)
+- [Nix](#nix-macos)
+- [Homebrew](#homebrew)
 
-If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo (go-ipfs) from:
-- this project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page
-- `/ipns/dist.ipfs.tech` at [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway
 
 ### Build from Source
 
@@ -323,42 +356,6 @@ dependencies as well.
 - Shell command completions can be generated with one of the `ipfs commands completion` subcommands. Read [docs/command-completion.md](docs/command-completion.md) to learn more.
 - See the [misc folder](https://github.com/ipfs/kubo/tree/master/misc) for how to connect IPFS to systemd or whatever init system your distro uses.
 
-### Updating
-
-#### 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](https://dist.ipfs.tech/#ipfs-update).
-
-#### Downloading builds using IPFS
-
-<!-- TODO: rename this section after we figure out if dist.ipfs.tech sgould produce both /go-ipfs/ and /kubo/ -->
-
-List the available versions of kubo (go-ipfs) implementation:
-
-```
-$ ipfs cat /ipns/dist.ipfs.tech/go-ipfs/versions
-```
-
-Then, to view available builds for a version from the previous command ($VERSION):
-
-```
-$ ipfs ls /ipns/dist.ipfs.tech/go-ipfs/$VERSION
-```
-
-To download a given build of a version:
-
-```
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-386.tar.gz # darwin 32-bit build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_darwin-amd64.tar.gz # darwin 64-bit build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_freebsd-amd64.tar.gz # freebsd 64-bit build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-386.tar.gz # linux 32-bit build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-amd64.tar.gz # linux 64-bit build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz # linux arm build
-$ ipfs get /ipns/dist.ipfs.tech/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build
-```
-
 ## Getting Started
 
 ### Usage