diff --git a/.circleci/main.yml b/.circleci/main.yml index af2de0d5833..b0c813e0799 100644 --- a/.circleci/main.yml +++ b/.circleci/main.yml @@ -14,13 +14,13 @@ aliases: restore_gomod: &restore_gomod restore_cache: keys: - - v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/go-ipfs/go.sum" }}-{{ .Environment.CIRCLE_JOB }} - - v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/go-ipfs/go.sum" }}- + - v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/kubo/go.sum" }}-{{ .Environment.CIRCLE_JOB }} + - v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/kubo/go.sum" }}- - v5-dep-{{ .Branch }}- - v5-dep-master- store_gomod: &store_gomod save_cache: - key: v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/go-ipfs/go.sum" }}-{{ .Environment.CIRCLE_JOB }} + key: v5-dep-{{ .Branch }}-{{ checksum "~/ipfs/kubo/go.sum" }}-{{ .Environment.CIRCLE_JOB }} paths: - ~/go/pkg/mod - ~/.cache/go-build/ @@ -38,7 +38,7 @@ executors: golang: docker: - image: cimg/go:1.18.3 - working_directory: ~/ipfs/go-ipfs + working_directory: ~/ipfs/kubo environment: <<: *default_environment TEST_NO_DOCKER: 1 @@ -47,13 +47,13 @@ executors: node: docker: - image: circleci/node:14 - working_directory: ~/ipfs/go-ipfs + working_directory: ~/ipfs/kubo environment: <<: *default_environment node-browsers: docker: - image: circleci/node:14-browsers - working_directory: ~/ipfs/go-ipfs + working_directory: ~/ipfs/kubo environment: <<: *default_environment NO_SANDBOX: true @@ -64,7 +64,7 @@ executors: docker: - image: cimg/go:1.18.3 environment: - IMAGE_NAME: ipfs/go-ipfs + IMAGE_NAME: ipfs/kubo WIP_IMAGE_TAG: wip jobs: @@ -108,21 +108,21 @@ jobs: command: bash <(curl -s https://codecov.io/bash) -cF unittests -X search -f coverage/unit_tests.coverprofile - run: command: | - # we want to first test with the go-ipfs in the go.mod file + # we want to first test with the kubo version in the go.mod file go test -v ./... - # we also want to test the examples against the current version of go-ipfs + # we also want to test the examples against the current version of kubo # however, that version might be in a fork so we need to replace the dependency # backup the go.mod and go.sum files to restore them after we run the tests cp go.mod go.mod.bak cp go.sum go.sum.bak - # make sure the examples run against the current version of go-ipfs + # make sure the examples run against the current version of kubo go mod edit -replace github.com/ipfs/kubo=./../../.. go mod tidy - # use the internal config package when we test the current version of go-ipfs + # use the internal config package when we test the current version of kubo sed -i.bak 's;"github.com/ipfs/go-ipfs-config";"github.com/ipfs/kubo/config";' ./main.go go test -v ./... @@ -133,7 +133,7 @@ jobs: # restore the main.go to its original state mv main.go.bak main.go - working_directory: ~/ipfs/go-ipfs/docs/examples/go-ipfs-as-a-library + working_directory: ~/ipfs/kubo/docs/examples/go-ipfs-as-a-library - run: when: always @@ -152,7 +152,7 @@ jobs: machine: image: ubuntu-2004:202010-01 resource_class: << pipeline.parameters.resource_class >> - working_directory: ~/ipfs/go-ipfs + working_directory: ~/ipfs/kubo environment: <<: *default_environment TEST_NO_DOCKER: 0 @@ -248,14 +248,14 @@ jobs: npm install ipfs@^0.61.0 npm install ipfs-interop@^8.0.10 npm install mocha-circleci-reporter@0.0.3 - working_directory: ~/ipfs/go-ipfs/interop + working_directory: ~/ipfs/kubo/interop - run: name: Running tests command: | mkdir -p /tmp/test-results/interop/ export MOCHA_FILE="$(mktemp /tmp/test-results/interop/unit.XXXXXX.xml)" npx ipfs-interop -- -t node -f $(sed -n -e "s|^import '\(.*\)'$|test/\1|p" node_modules/ipfs-interop/test/node.js | circleci tests split --split-by=timings) -- --reporter mocha-circleci-reporter - working_directory: ~/ipfs/go-ipfs/interop + working_directory: ~/ipfs/kubo/interop environment: LIBP2P_TCP_REUSEPORT: false LIBP2P_ALLOW_WEAK_RSA_KEYS: 1 @@ -265,7 +265,7 @@ jobs: - save_cache: key: v1-interop-{{ .Branch }}-{{ .Revision }} paths: - - ~/ipfs/go-ipfs/interop/node_modules + - ~/ipfs/kubo/interop/node_modules go-ipfs-api: executor: golang steps: @@ -290,13 +290,13 @@ jobs: done - restore_cache: keys: - - v1-go-api-{{ checksum "~/ipfs/go-ipfs/go-ipfs-api/go.sum" }} + - v1-go-api-{{ checksum "~/ipfs/kubo/go-ipfs-api/go.sum" }} - v1-go-api- - run: command: go test -count=1 -v ./... - working_directory: ~/ipfs/go-ipfs/go-ipfs-api + working_directory: ~/ipfs/kubo/go-ipfs-api - save_cache: - key: v1-go-api-{{ checksum "~/ipfs/go-ipfs/go-ipfs-api/go.sum" }} + key: v1-go-api-{{ checksum "~/ipfs/kubo/go-ipfs-api/go.sum" }} paths: - ~/go/pkg/mod - ~/.cache/go-build/ @@ -316,16 +316,16 @@ jobs: git -C go-ipfs-http-client log -1 - restore_cache: keys: - - v1-http-client-{{ checksum "~/ipfs/go-ipfs/go-ipfs-http-client/go.sum" }} + - v1-http-client-{{ checksum "~/ipfs/kubo/go-ipfs-http-client/go.sum" }} - v1-http-client- - run: name: go test -count=1 -v ./... command: | export PATH=/tmp/circleci-workspace/bin:$PATH go test -count=1 -v ./... - working_directory: ~/ipfs/go-ipfs/go-ipfs-http-client + working_directory: ~/ipfs/kubo/go-ipfs-http-client - save_cache: - key: v1-http-client-{{ checksum "~/ipfs/go-ipfs/go-ipfs-http-client/go.sum" }} + key: v1-http-client-{{ checksum "~/ipfs/kubo/go-ipfs-http-client/go.sum" }} paths: - ~/go/pkg/mod - ~/.cache/go-build/ @@ -338,36 +338,36 @@ jobs: - run: name: Cloning command: | - git clone https://github.com/ipfs-shipyard/ipfs-webui.git + git clone https://github.com/ipfs/ipfs-webui.git git -C ipfs-webui log -1 - restore_cache: keys: - - v1-ipfs-webui-{{ checksum "~/ipfs/go-ipfs/ipfs-webui/package-lock.json" }} + - v1-ipfs-webui-{{ checksum "~/ipfs/kubo/ipfs-webui/package-lock.json" }} - v1-ipfs-webui- - run: name: Installing dependencies command: | npm install npx playwright install - working_directory: ~/ipfs/go-ipfs/ipfs-webui + working_directory: ~/ipfs/kubo/ipfs-webui - run: name: Running upstream tests (finish early if they fail) command: | npm test || circleci-agent step halt - working_directory: ~/ipfs/go-ipfs/ipfs-webui + working_directory: ~/ipfs/kubo/ipfs-webui - run: - name: Running tests with go-ipfs built from current commit + name: Running tests with kubo built from current commit command: npm test - working_directory: ~/ipfs/go-ipfs/ipfs-webui + working_directory: ~/ipfs/kubo/ipfs-webui environment: IPFS_GO_EXEC: /tmp/circleci-workspace/bin/ipfs - save_cache: - key: v1-ipfs-webui-{{ checksum "~/ipfs/go-ipfs/ipfs-webui/package-lock.json" }} + key: v1-ipfs-webui-{{ checksum "~/ipfs/kubo/ipfs-webui/package-lock.json" }} paths: - ~/.cache/ms-playwright - - ~/ipfs/go-ipfs/ipfs-webui/node_modules + - ~/ipfs/kubo/ipfs-webui/node_modules # We only run build as a test here. DockerHub images are built and published - # by GitHub Action now: https://github.com/ipfs/go-ipfs/pull/8467 + # by GitHub Action now: https://github.com/ipfs/kubo/pull/8467 docker-build: executor: dockerizer steps: diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 96b29dc8bac..d648b61814c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: Report a bug in go-ipfs. +description: Report a bug in Kubo. labels: - kind/bug - need/triage @@ -7,12 +7,12 @@ body: - type: markdown attributes: value: | - - Make sure you are running the [latest version of go-ipfs][releases] before reporting an issue. - - If you have an enhancement or feature request for go-ipfs, please select [a different option][issues]. + - Make sure you are running the [latest version of Kubo][releases] before reporting an issue. + - If you have an enhancement or feature request for Kubo, please select [a different option][issues]. - Please report possible security issues by email to security@ipfs.io - [issues]: https://github.com/ipfs/go-ipfs/issues/new/choose - [releases]: https://github.com/ipfs/go-ipfs/releases + [issues]: https://github.com/ipfs/kubo/issues/new/choose + [releases]: https://github.com/ipfs/kubo/releases - type: checkboxes attributes: label: Checklist @@ -20,9 +20,9 @@ body: options: - label: This is a bug report, not a question. Ask questions on [discuss.ipfs.io](https://discuss.ipfs.io). required: true - - label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my bug. + - label: I have searched on the [issue tracker](https://github.com/ipfs/kubo/issues?q=is%3Aissue) for my bug. required: true - - label: I am running the latest [go-ipfs version](https://dist.ipfs.io/#go-ipfs) or have an issue updating. + - label: I am running the latest [kubo version](https://dist.ipfs.io/#kubo) or have an issue updating. required: true - type: dropdown id: install diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 27fef31b01c..f9fa316c433 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,15 +3,15 @@ contact_links: - name: Getting Help on IPFS url: https://ipfs.io/help about: All information about how and where to get help on IPFS. - - name: Go-ipfs configuration reference - url: https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#readme + - name: Kubo configuration reference + url: https://github.com/ipfs/kubo/blob/master/docs/config.md#readme about: Documentation on the different configuration settings - - name: Go-ipfs experimental features docs - url: https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#readme + - name: Kubo experimental features docs + url: https://github.com/ipfs/kubo/blob/master/docs/experimental-features.md#readme about: Documentation on Private Networks, Filestore and other experimental features. - name: RPC API Reference url: https://docs.ipfs.io/reference/http/api/ - about: Documentation of all go-ipfs RPC API endpoints. + about: Documentation of all Kubo RPC API endpoints. - name: IPFS Official Forum url: https://discuss.ipfs.io about: Please post general questions, support requests, and discussions here. diff --git a/.github/ISSUE_TEMPLATE/doc.yml b/.github/ISSUE_TEMPLATE/doc.yml index dc9034fae5a..cbb0c9fb046 100644 --- a/.github/ISSUE_TEMPLATE/doc.yml +++ b/.github/ISSUE_TEMPLATE/doc.yml @@ -1,5 +1,5 @@ name: Documentation Issue -description: Report missing, erroneous docs, broken links or propose new go-ipfs docs. +description: Report missing, erroneous docs, broken links or propose new Kubo docs. labels: - topic/docs-ipfs - need/triage @@ -15,7 +15,7 @@ body: options: - label: I am reporting a documentation issue in this repo, not https://docs.ipfs.io. required: true - - label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue. + - label: I have searched on the [issue tracker](https://github.com/ipfs/kubo/issues?q=is%3Aissue) for my issue. required: true - type: input attributes: diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index f1be06c358c..9bfeba5b516 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -1,12 +1,12 @@ name: Enhancement -description: Suggest an improvement to an existing go-ipfs feature. +description: Suggest an improvement to an existing kubo feature. labels: - kind/enhancement body: - type: markdown attributes: value: | - Suggest an enhancement to go-ipfs (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io). + Suggest an enhancement to Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io). Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas. @@ -14,7 +14,7 @@ body: **Example:** - > Reduce memory usage of `ipfs cat` (specific) by buffering less in ... (actionable). This would let me run go-ipfs on my Raspberry Pi (motivated). + > Reduce memory usage of `ipfs cat` (specific) by buffering less in ... (actionable). This would let me run Kubo on my Raspberry Pi (motivated). - type: checkboxes attributes: label: Checklist @@ -24,7 +24,7 @@ body: required: true - label: I am not suggesting a protocol enhancement. required: true - - label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue. + - label: I have searched on the [issue tracker](https://github.com/ipfs/kubo/issues?q=is%3Aissue) for my issue. required: true - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 62414cabb02..cf2fa81167f 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,12 +1,12 @@ name: Feature -description: Suggest a new feature in go-ipfs. +description: Suggest a new feature in Kubo. labels: - kind/feature body: - type: markdown attributes: value: | - Suggest a new feature in go-ipfs (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io). + Suggest a new feature in Kubo (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io). Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas. @@ -25,7 +25,7 @@ body: required: true - label: I am not suggesting a protocol enhancement. required: true - - label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue. + - label: I have searched on the [issue tracker](https://github.com/ipfs/kubo/issues?q=is%3Aissue) for my issue. required: true - type: textarea attributes: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 39f7073f5e6..02989e6aa3b 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,7 +13,7 @@ on: jobs: analyze: - if: github.repository == 'ipfs/go-ipfs' || github.event_name == 'workflow_dispatch' + if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch' name: Analyze runs-on: ubuntu-latest diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 8b70ee682c4..76e0c1c1190 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -11,7 +11,7 @@ on: jobs: push_to_registry: - if: github.repository == 'ipfs/go-ipfs' || github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch' + if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch' name: Push Docker image to Docker Hub runs-on: ubuntu-latest env: diff --git a/.github/workflows/sync-release-assets.yml b/.github/workflows/sync-release-assets.yml index f6ca267199d..bdafdbea79b 100644 --- a/.github/workflows/sync-release-assets.yml +++ b/.github/workflows/sync-release-assets.yml @@ -11,7 +11,7 @@ concurrency: jobs: sync-github-and-dist-ipfs-io: - if: github.repository == 'ipfs/go-ipfs' || github.event_name == 'workflow_dispatch' + if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch' runs-on: "ubuntu-latest" steps: - uses: ipfs/download-ipfs-distribution-action@v1 @@ -51,7 +51,7 @@ jobs: } // fetch asset info from dist.ipfs.io - p = '/ipns/dist.ipfs.io/go-ipfs/' + release.tag_name + p = '/ipns/dist.ipfs.io/kubo/' + release.tag_name let stdout = '' const options = {} options.listeners = { diff --git a/.github/workflows/testground-on-push.yml b/.github/workflows/testground-on-push.yml index a73018ca7e9..7b55dbdee3b 100644 --- a/.github/workflows/testground-on-push.yml +++ b/.github/workflows/testground-on-push.yml @@ -8,7 +8,7 @@ on: jobs: testground: - if: github.repository == 'ipfs/go-ipfs' || github.event_name == 'workflow_dispatch' + if: github.repository == 'ipfs/kubo' || github.event_name == 'workflow_dispatch' runs-on: ubuntu-latest name: ${{ matrix.composition_file }} strategy: diff --git a/README.md b/README.md index cb63274e8fc..48110e00227 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > the oldest IPFS implementation, previously known as "go-ipfs" -![kubo](https://user-images.githubusercontent.com/157609/167471494-dee3a355-b551-4fbf-98e0-2eb76e867b48.png) +![kubo, an IPFS node in Go](https://ipfs.io/ipfs/bafykbzacecaesuqmivkauix25v6i6xxxsvsrtxknhgb5zak3xxsg2nb4dhs2u/ipfs.go.png) [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square&cacheSeconds=3600)](https://protocol.ai) [![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square&cacheSeconds=3600)](https://godoc.org/github.com/ipfs/kubo) diff --git a/core/corehttp/commands.go b/core/corehttp/commands.go index b433dfea7d7..c0ebf550616 100644 --- a/core/corehttp/commands.go +++ b/core/corehttp/commands.go @@ -85,7 +85,7 @@ func addHeadersFromConfig(c *cmdsHttp.ServerConfig, nc *config.Config) { c.Headers[h] = v } } - c.Headers["Server"] = []string{"go-ipfs/" + version.CurrentVersionNumber} + c.Headers["Server"] = []string{"kubo/" + version.CurrentVersionNumber} } func addCORSDefaults(c *cmdsHttp.ServerConfig) { @@ -163,7 +163,7 @@ func CommandsROOption(cctx oldcmds.Context) ServeOption { return commandsOption(cctx, corecommands.RootRO, true) } -// CheckVersionOption returns a ServeOption that checks whether the client ipfs version matches. Does nothing when the user agent string does not contain `/go-ipfs/` +// CheckVersionOption returns a ServeOption that checks whether the client ipfs version matches. Does nothing when the user agent string does not contain `/kubo/` or `/go-ipfs/` func CheckVersionOption() ServeOption { daemonVersion := version.ApiVersion @@ -177,8 +177,8 @@ func CheckVersionOption() ServeOption { // backwards compatibility to previous version check if len(pth) >= 2 && pth[1] != "version" { clientVersion := r.UserAgent() - // skips check if client is not go-ipfs - if strings.Contains(clientVersion, "/go-ipfs/") && daemonVersion != clientVersion { + // skips check if client is not kubo (go-ipfs) + if (strings.Contains(clientVersion, "/go-ipfs/") || strings.Contains(clientVersion, "/kubo/")) && daemonVersion != clientVersion { http.Error(w, fmt.Sprintf("%s (%s != %s)", errAPIVersionMismatch, daemonVersion, clientVersion), http.StatusBadRequest) return } diff --git a/docs/EARLY_TESTERS.md b/docs/EARLY_TESTERS.md index c68d00453f4..c3e9108772f 100644 --- a/docs/EARLY_TESTERS.md +++ b/docs/EARLY_TESTERS.md @@ -2,7 +2,7 @@ ## What is it? -The early testers programme allows groups using go-ipfs in production to self-volunteer to help test `go-ipfs` release candidates to ensure that no regressions that might affect production systems make it into the final release. While we invite the _entire_ community to help test releases, members of the early testers program are expected to participate directly and actively in every release. +The early testers programme allows groups using Kubo in production to self-volunteer to help test `kubo` release candidates to ensure that no regressions that might affect production systems make it into the final release. While we invite the _entire_ community to help test releases, members of the early testers program are expected to participate directly and actively in every release. ## What are the expectations? @@ -14,11 +14,11 @@ Members of the early tester program are expected to work closely with us to: We will ask early testers to participate at two points in the process: -* When go-ipfs enters the second release stage (public beta), early testers will be asked to test go-ipfs on non-production infrastructure. This may involve things like: +* When Kubo enters the second release stage (public beta), early testers will be asked to test Kubo on non-production infrastructure. This may involve things like: - Running integration tests against the release candidate. - Running simulations/benchmarks on the release candidate. - Manually testing the release candidate to check for regressions. -* When go-ipfs enters the third release stage (soft release), early testers will be asked to partially deploy the release candidate to production infrastructure. Release candidates at this stage are expected to be identical to the final release. However, this stage allows the go-ipfs team to fix any last-minute regressions without cutting an entirely new release. +* When Kubo enters the third release stage (soft release), early testers will be asked to partially deploy the release candidate to production infrastructure. Release candidates at this stage are expected to be identical to the final release. However, this stage allows the Kubo team to fix any last-minute regressions without cutting an entirely new release. ## Who has signed up? diff --git a/docs/PATCH_RELEASE_TEMPLATE.md b/docs/PATCH_RELEASE_TEMPLATE.md index 1cce02a4f27..127543d1429 100644 --- a/docs/PATCH_RELEASE_TEMPLATE.md +++ b/docs/PATCH_RELEASE_TEMPLATE.md @@ -1,6 +1,6 @@ # Patch Release Checklist -This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming that `vX.Y.Z` is the latest released version of go-ipfs. +This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming that `vX.Y.Z` is the latest released version of Kubo. - [ ] Get temporary permissions to force-push to `release-*` branches - [ ] Fork a new branch (`release-vX.Y.Z`) from `release` and cherry-pick the relevant commits from master (or custom fixes) onto this branch @@ -15,7 +15,7 @@ This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming 2. Pin the resulting release. 3. Make a PR against ipfs/distributions with the updated versions, including the new hash in the PR comment. 4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution. -- [ ] cut a release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. +- [ ] cut a release on [github](https://github.com/ipfs/kubo/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the Release: - [ ] On IRC/Matrix (both #ipfs and #ipfs-dev) - [ ] On discuss.ipfs.io @@ -24,7 +24,7 @@ This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming - [ ] to [npm-go-ipfs](https://github.com/ipfs/npm-go-ipfs) - [ ] to [chocolatey](https://chocolatey.org/packages/ipfs) - [ ] to [snap](https://snapcraft.io/ipfs) - - [ ] to [github](https://github.com/ipfs/go-ipfs/releases) + - [ ] to [github](https://github.com/ipfs/kubo/releases) - [ ] to [arch](https://www.archlinux.org/packages/community/x86_64/go-ipfs/) (flag it out of date) - [ ] Cut a new ipfs-desktop release - [ ] Merge the `release` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master). diff --git a/docs/README.md b/docs/README.md index 13ba9219f27..7d867d3099b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,9 +6,9 @@ If you’re experiencing an issue with IPFS, **please follow [our issue guide](g Otherwise, check out the following guides to using and developing IPFS: -## Developing `go-ipfs` +## Developing `kubo` -- First, please read the Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and then the Contributing Guidelines for [go-ipfs specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md) +- First, please read the Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and then the Contributing Guidelines for [Go code specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md) - Building on… - [Windows](windows.md) - [Performance Debugging Guidelines](debug-guide.md) @@ -17,7 +17,7 @@ Otherwise, check out the following guides to using and developing IPFS: ## Guides - [How to Implement an API Client](implement-api-bindings.md) -- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `go-ipfs` node, you will need to turn on websocket support in your `go-ipfs` node. +- [Connecting with Websockets](transports.md) — if you want `js-ipfs` nodes in web browsers to connect to your `kubo` node, you will need to turn on websocket support in your `kubo` node. ## Advanced User Guides @@ -28,7 +28,7 @@ Otherwise, check out the following guides to using and developing IPFS: - [Installing command completion](command-completion.md) - [Mounting IPFS with FUSE](fuse.md) - [Installing plugins](plugins.md) -- [Setting up an IPFS Gateway](https://github.com/ipfs/go-ipfs/blob/master/docs/gateway.md) +- [Setting up an IPFS Gateway](https://github.com/ipfs/kubo/blob/master/docs/gateway.md) ## Other diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index 3f276f26305..bfa3bbca0e6 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -1,8 +1,8 @@ > Release Issue Template -# go-ipfs X.Y.Z Release +# Kubo X.Y.Z Release -We're happy to announce go-ipfs X.Y.Z, bla bla... +We're happy to announce Kubo X.Y.Z, bla bla... As usual, this release includes important fixes, some of which may be critical for security. Unless the fix addresses a bug being exploited in the wild, the fix will _not_ be called out in the release notes. Please make sure to update ASAP. See our [release process](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md#security-fix-policy) for details. @@ -29,7 +29,7 @@ For each RC published in each stage: 2. Pin the resulting release. 3. Make a PR against ipfs/distributions with the updated versions, including the new hash in the PR comment. 4. Ask the infra team to update the DNSLink record for dist.ipfs.io to point to the new distribution. -- cut a pre-release on [github](https://github.com/ipfs/go-ipfs/releases) and upload the result of the ipfs/distributions build in the previous step. +- cut a pre-release on [github](https://github.com/ipfs/kubo/releases) and upload the result of the ipfs/distributions build in the previous step. - Announce the RC: - [ ] On Matrix (both #ipfs and #ipfs-dev) - [ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Do this by copy/pasting their GitHub usernames and checkboxes as a comment so they get a GitHub notification. ([example](https://github.com/ipfs/go-ipfs/issues/8176#issuecomment-909356394)) @@ -40,7 +40,7 @@ Checklist: - [ ] Upgrade to the latest patch release of Go that CircleCI has published - [ ] See the list here: https://hub.docker.com/r/cimg/go/tags - [ ] [ipfs/distributions](https://github.com/ipfs/distributions): bump [this version](https://github.com/ipfs/distributions/blob/master/.tool-versions#L2) - - [ ] [ipfs/go-ipfs](https://github.com/ipfs/go-ipfs): [example PR](https://github.com/ipfs/go-ipfs/pull/8599) + - [ ] [ipfs/kubo](https://github.com/ipfs/kubo): [example PR](https://github.com/ipfs/kubo/pull/8599) - [ ] Fork a new branch (`release-vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes (see the footnotes of [docs/releases.md](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md) for a definition) get added to the release, uncheck all the checkboxes and return to this stage. - [ ] Follow the RC release process to cut the first RC. - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`. @@ -85,7 +85,7 @@ Checklist: - [ ] Manually run [the release workflow](https://github.com/ipfs/choco-go-ipfs/actions/workflows/main.yml) - [ ] to [snap](https://snapcraft.io/ipfs) - [ ] to [github](https://github.com/ipfs/go-ipfs/releases) - - [ ] use the artifacts built in CI for dist.ipfs.io: `wget "https://ipfs.io/api/v0/get?arg=/ipns/dist.ipfs.io/go-ipfs/$(curl -s https://dist.ipfs.io/go-ipfs/versions | tail -n 1)"` + - [ ] use the artifacts built in CI for dist.ipfs.io: `wget "https://ipfs.io/api/v0/get?arg=/ipns/dist.ipfs.io/kubo/$(curl -s https://dist.ipfs.io/kubo/versions | tail -n 1)"` - [ ] to [arch](https://www.archlinux.org/packages/community/x86_64/go-ipfs/) (flag it out of date) - [ ] Cut a new ipfs-desktop release - [ ] Submit [this form](https://airtable.com/shrNH8YWole1xc70I) to publish a blog post, linking to the GitHub release notes @@ -124,7 +124,7 @@ The best place to ask your questions about IPFS, how it works and what you can d Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started: -- Check the issues with the `help wanted` label in the [go-ipfs repo](https://github.com/ipfs/go-ipfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) +- Check the issues with the `help wanted` label in the [ipfs/kubo repo](https://github.com/ipfs/kubo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands - Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built - Join the discussion at [discuss.ipfs.io](https://discuss.ipfs.io/) and help users finding their answers. diff --git a/docs/config.md b/docs/config.md index deb91cb490b..29e76af239b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,13 +1,13 @@ -# The go-ipfs config file +# The Kubo config file -The go-ipfs config file is a JSON document located at `$IPFS_PATH/config`. It +The Kubo (go-ipfs) config file is a JSON document located at `$IPFS_PATH/config`. It is read once at node instantiation, either for an offline command, or when starting the daemon. Commands that execute on a running daemon do not read the config file at runtime. # Table of Contents -- [The go-ipfs config file](#the-go-ipfs-config-file) +- [The Kubo config file](#the-kubo-config-file) - [Table of Contents](#table-of-contents) - [Profiles](#profiles) - [Types](#types) @@ -245,7 +245,7 @@ This document refers to the standard JSON types (e.g., `null`, `string`, Flags allow enabling and disabling features. However, unlike simple booleans, they can also be `null` (or omitted) to indicate that the default value should -be chosen. This makes it easier for go-ipfs to change the defaults in the +be chosen. This makes it easier for Kubo to change the defaults in the future unless the user _explicitly_ sets the flag to either `true` (enabled) or `false` (disabled). Flags have three possible states: @@ -281,7 +281,7 @@ does (e.g, `"1d2h4m40.01s"`). Optional integers allow specifying some numerical value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault(value)`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault(value)`) - an integer between `-2^63` and `2^63-1` (i.e. `-9223372036854775808` to `9223372036854775807`) ### `optionalBytes` @@ -289,7 +289,7 @@ an implicit default when missing from the config file: Optional Bytes allow specifying some number of bytes which has an implicit default when missing from the config file: -- `null`/missing (apply the default value defined in go-ipfs sources) +- `null`/missing (apply the default value defined in Kubo sources) - a string value indicating the number of bytes, including human readable representations: - [SI sizes](https://en.wikipedia.org/wiki/Metric_prefix#List_of_SI_prefixes) (metric units, powers of 1000), e.g. `1B`, `2kB`, `3MB`, `4GB`, `5TB`, …) - [IEC sizes](https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes) (binary units, powers of 1024), e.g. `1B`, `2KiB`, `3MiB`, `4GiB`, `5TiB`, …) @@ -299,7 +299,7 @@ an implicit default when missing from the config file: Optional strings allow specifying some string value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("value")`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault("value")`) - a string ### `optionalDuration` @@ -307,7 +307,7 @@ an implicit default when missing from the config file: Optional durations allow specifying some duration value which has an implicit default when missing from the config file: -- `null`/missing will apply the default value defined in go-ipfs sources (`.WithDefault("1h2m3s")`) +- `null`/missing will apply the default value defined in Kubo sources (`.WithDefault("1h2m3s")`) - a string with a valid [go duration](#duration) (e.g, `"1d2h4m40.01s"`). ## `Addresses` @@ -431,7 +431,7 @@ Type: `string` (one of `"enabled"` or `"disabled"`) ### `AutoNAT.Throttle` When set, this option configure's the AutoNAT services throttling behavior. By -default, go-ipfs will rate-limit the number of NAT checks performed for other +default, Kubo will rate-limit the number of NAT checks performed for other nodes to 30 per minute, and 3 per peer. ### `AutoNAT.Throttle.GlobalLimit` @@ -671,7 +671,7 @@ Type: `bool` ### `Gateway.PathPrefixes` -**DEPRECATED:** see [go-ipfs#7702](https://github.com/ipfs/go-ipfs/issues/7702) +**DEPRECATED:** see [kubo#7702](https://github.com/ipfs/kubo/issues/7702)