Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: go-ipfs -> kubo name update #2022

Merged
merged 2 commits into from
Sep 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
# see: https://github.com/ipfs-shipyard/ipfs-github-action
- uses: ipfs/download-ipfs-distribution-action@v1
with:
name: go-ipfs
name: kubo
- uses: ipfs/download-ipfs-distribution-action@v1
with:
name: ipfs-cluster-ctl
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# IPFS Web UI

> A web interface to [IPFS](https://ipfs.io), shipped with [go-ipfs](https://github.com/ipfs/go-ipfs), [js-ipfs](https://github.com/ipfs/js-ipfs), and [ipfs-desktop](https://github.com/ipfs/ipfs-desktop/).
> A web interface to [IPFS](https://ipfs.io), shipped with [Kubo](https://github.com/ipfs/kubo), and [ipfs-desktop](https://github.com/ipfs/ipfs-desktop/).
>
> Check on your node stats, explore the IPLD powered merkle forest, see peers around the world and manage your files, without needing to touch the CLI.

Expand Down Expand Up @@ -97,11 +97,11 @@ If you need to run IPFS in a Docker container, you can still have Web UI availab
Using the default ports:

```sh
docker pull ipfs/go-ipfs
docker run -p 8080:8080 -p 5001:5001 -it ipfs/go-ipfs
docker pull ipfs/kubo
docker run -p 8080:8080 -p 5001:5001 -it ipfs/kubo
```

See the [go-ipfs page](https://hub.docker.com/r/ipfs/go-ipfs) on Docker Hub to get started using IPFS with Docker.
See the [kubo page](https://hub.docker.com/r/ipfs/kubo) on Docker Hub to get started using IPFS with Docker.

## Build

Expand Down Expand Up @@ -140,7 +140,7 @@ Make sure `npm run build` is run before starting E2E tests:

```sh
> npm run build
> npm run test:e2e # end-to-end smoke tests (fast, headless, use Kubo (go-ipfs))
> npm run test:e2e # end-to-end smoke tests (fast, headless, use Kubo)
```

### Customizing E2E Tests
Expand Down Expand Up @@ -263,14 +263,14 @@ You can read more on how we use Transifex and i18next in this app at [`docs/LOCA

1. Check that the [Transifex sync action](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true) is [successful](https://github.com/ipfs/ipfs-webui/runs/7121497704?check_suite_focus=true) or [fails because there are no updates](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true).
1. If UI is materially different, update screenshots in `README.md` and on docs.ipfs.io [here](https://docs.ipfs.io/how-to/command-line-quick-start/#web-console)
1. Manually dispatch [ci.yml](https://github.com/ipfs/ipfs-webui/actions/workflows/ci.yml) workflow on `main` branch. This will create a new release.
1. Manually dispatch [ci.yml](https://github.com/ipfs/ipfs-webui/actions/workflows/ci.yml) workflow on `main` branch. This will create a new release.
1. If release is good enough for LTS, update the CID at projects that use ipfs-webui by submitting PR against below lines:
- ~js-ipfs: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-http-server/src/api/routes/webui.js#L5~
- currently blocked by https://github.com/ipfs/ipfs-webui/issues/1730
- Kubo: https://github.com/ipfs/kubo/blob/master/core/corehttp/webui.go#L4
- IPFS Desktop: https://github.com/ipfs/ipfs-desktop/blob/main/package.json#L20

<!-- DEPRECATED STEPS as of https://github.com/ipfs/ipfs-webui/releases/tag/v2.16.0. Leaving only for posterity:
<!-- DEPRECATED STEPS as of https://github.com/ipfs/ipfs-webui/releases/tag/v2.16.0. Leaving only for posterity:
1. Check that the [Transifex sync action](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true) is [successful](https://github.com/ipfs/ipfs-webui/runs/7121497704?check_suite_focus=true) or [fails because there are no updates](https://github.com/ipfs/ipfs-webui/runs/7165373056?check_suite_focus=true).
1. If UI is materially different, update screenshots in `README.md` and on docs.ipfs.io [here](https://docs.ipfs.io/how-to/command-line-quick-start/#web-console)
1. Commit changes and ensure everything is merged into `main` branch
Expand Down
2 changes: 1 addition & 1 deletion public/locales/en/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"pinningServices": {
"title": "Pinning Services",
"description": "Use local pinning when you want to ensure an item on your node is never garbage-collected, even if you remove it from Files. You can also link your accounts with other remote pinning services to automatically or selectively persist files with those providers, enabling you to keep backup copies of your files and/or make them available to others when your local node is offline.",
"noPinRemoteDescription": "Support for third-party remote pinning services is missing. Update your IPFS node to go-ipfs 0.8.0 or later, and you'll be able to add and configure them here.",
"noPinRemoteDescription": "Support for third-party remote pinning services is missing. Update your IPFS node to Kubo 0.8.0 or later, and you'll be able to add and configure them here.",
"addAutoUpload": "Enable auto upload",
"removeAutoUpload": "Disable Auto Upload"
},
Expand Down
2 changes: 1 addition & 1 deletion src/bundles/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ const checkIfGatewayUrlIsAccessible = memoize(async (url) => {

// Separate test is necessary to see if subdomain mode is possible,
// because some browser+OS combinations won't resolve them:
// https://github.com/ipfs/go-ipfs/issues/7527
// https://github.com/ipfs/kubo/issues/7527
const checkIfSubdomainGatewayUrlIsAccessible = memoize(async (url) => {
try {
url = new URL(url)
Expand Down
2 changes: 1 addition & 1 deletion src/bundles/gateway.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { readSetting, writeSetting } from './local-storage'

export const DEFAULT_GATEWAY = 'https://ipfs.io' // TODO: switch to dweb.link when https://github.com/ipfs/go-ipfs/issues/7318
export const DEFAULT_GATEWAY = 'https://ipfs.io' // TODO: switch to dweb.link when https://github.com/ipfs/kubo/issues/7318
const IMG_ARRAY = [
{ id: 'IMG_HASH_1PX', name: '1x1.png', hash: 'bafybeibwzifw52ttrkqlikfzext5akxu7lz4xiwjgwzmqcpdzmp3n5vnbe' },
{ id: 'IMG_HASH_1PXID', name: '1x1.png', hash: 'bafkqax4jkbheodikdifaaaaabveuqrcsaaaaaaiaaaaacaidaaaaajo3k3faaaaaanieyvcfaaaabj32hxnaaaaaaf2fetstabaonwdgaaaaacsjiravicgxmnqaaaaaaiaadyrbxqzqaaaaabeuktsevzbgbaq' },
Expand Down
2 changes: 1 addition & 1 deletion src/bundles/peers.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ bundle.doConnectSwarm = (addr, permanent) => async ({ dispatch, getIpfs, store }
const peerId = maddr.getPeerId()
const rawAddr = maddr.decapsulateCode(421).toString() // drop /p2p suffix

// TODO: switch to ipfs.swarm.peering when https://github.com/ipfs/go-ipfs/pull/8147 ships
// TODO: switch to ipfs.swarm.peering when https://github.com/ipfs/kubo/pull/8147 ships
let peers = (await ipfs.config.get('Peering.Peers')) || []
const preexisting = peers.find(p => p.ID === peerId)
if (preexisting) {
Expand Down
4 changes: 2 additions & 2 deletions src/bundles/pinning.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const mfsPolicyEnableFlag = memoize(async (serviceName, ipfs) => {
return await ipfs.config.get(`Pinning.RemoteServices.${serviceName}.Policies.MFS.Enable`)
} catch (e) {
if (e.message?.includes('key has no attribute')) {
try { // retry with notation from https://github.com/ipfs/go-ipfs/pull/8096
try { // retry with notation from https://github.com/ipfs/kubo/pull/8096
return await ipfs.config.get(`Pinning.RemoteServices["${serviceName}"].Policies.MFS.Enable`)
} catch (_) {}
}
Expand Down Expand Up @@ -129,7 +129,7 @@ const pinningBundle = {
const notPins = new Set(cidsToCheck.map(cid => cid.toString()))
try {
/* TODO: wrap pin.remote.*calls with progressive backoff when response Type == "error" and Message includes "429 Too Many Requests"
* and see if we could make go-ipfs include Retry-After header in payload description for this type of error */
* and see if we could make kubo include Retry-After header in payload description for this type of error */
const pins = ipfs.pin.remote.ls({ service: service.name, cid: cidsToCheck.map(cid => new CID(cid)) })
for await (const pin of pins) {
const pinCid = pin.cid.toString()
Expand Down
2 changes: 1 addition & 1 deletion src/components/is-not-connected/IsNotConnected.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const IsNotConnected = ({ t, apiUrl, connected, sameOrigin, ipfsApiAddress, doUp
</div>
)}
<Trans i18nKey='notConnected.paragraph4' t={t}>
<li className='mt4 mb3'>Is your IPFS API on a port other than 5001? If your node is configured with a <a className='link blue' href='https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom API address</a>, enter it here.</li>
<li className='mt4 mb3'>Is your IPFS API on a port other than 5001? If your node is configured with a <a className='link blue' href='https://github.com/ipfs/kubo/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom API address</a>, enter it here.</li>
</Trans>
<ApiAddressForm
t={t}
Expand Down
2 changes: 1 addition & 1 deletion src/lib/files.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export async function makeCIDFromFiles (files, ipfs) {
// Note: we don't use 'object patch' here, it was deprecated.
// We are using MFS for creating CID of an ephemeral directory
// because it handles HAMT-sharding of big directories automatically
// See: https://github.com/ipfs/go-ipfs/issues/8106
// See: https://github.com/ipfs/kubo/issues/8106
const dirpath = `/zzzz_${Date.now()}`
await ipfs.files.mkdir(dirpath, {})

Expand Down
4 changes: 2 additions & 2 deletions src/settings/SettingsPage.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export const SettingsPage = ({
<div className='lh-copy charcoal'>
<Title>{t('app:terms.apiAddress')}</Title>
<Trans i18nKey='apiDescription' t={t}>
<p>If your node is configured with a <a className='link blue' href='https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom API address</a>, including a port other than the default 5001, enter it here.</p>
<p>If your node is configured with a <a className='link blue' href='https://github.com/ipfs/kubo/blob/master/docs/config.md#addresses' target='_blank' rel='noopener noreferrer'>custom API address</a>, including a port other than the default 5001, enter it here.</p>
</Trans>
<ApiAddressForm/>
</div>
Expand Down Expand Up @@ -253,7 +253,7 @@ const SettingsInfo = ({ t, isIpfsConnected, isConfigBlocked, hasExternalChanges,
}
return (
<p className='ma0 mr2 lh-copy charcoal f5'>
{t('ipfsConfigDescription')} <a href='https://github.com/ipfs/go-ipfs/blob/master/docs/config.md' rel='noopener noreferrer' target='_blank' className='link blue'>{t('ipfsConfigHelp')}</a>
{t('ipfsConfigDescription')} <a href='https://github.com/ipfs/kubo/blob/master/docs/config.md' rel='noopener noreferrer' target='_blank' className='link blue'>{t('ipfsConfigHelp')}</a>
</p>
)
}
Expand Down