Skip to content

Commit

Permalink
Merge branch 'main' into editorial/frontdoor-overhauling
Browse files Browse the repository at this point in the history
  • Loading branch information
@bumblefudge
bumblefudge authored Nov 18, 2024
2 parents 4c15cb9 + 3a12d10 commit e5e33e4
Show file tree
Hide file tree
Showing 6 changed files with 340 additions and 299 deletions.
7 changes: 6 additions & 1 deletion docs/concepts/public-utilities.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,15 @@ The IPFS Foundation provides several public bootstrap nodes that are published a
- `/dnsaddr/sg1.bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt`
- `/dnsaddr/sv15.bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN`
- `/dnsaddr/am6.bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb`
- `/dnsaddr/ny5.bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa`
- `/dnsaddr/ny5.bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa` ([Rust based](https://blog.ipfs.tech/2023-rust-libp2p-based-ipfs-bootstrap-node/))


> **Note:** You can query DNS for the specific records with the following command: `dig +short TXT _dnsaddr.bootstrap.libp2p.io`
To increase resilience and implementation diversity, as of 2024, the IPFS Foundation also provides a bootstrap node powered by [js-libp2p](https://github.com/libp2p/js-libp2p-amino-dht-bootstrapper) at:

`/dnsaddr/va1.bootstrap.libp2p.io/p2p/12D3KooWKnDdG3iXw9eTFijk3EWSunZcFi54Zka4wmtqtt6rPxc8`.

## Frequently Asked Questions (FAQs)

### How is the ipfs.io gateway different from other gateways?
Expand Down
40 changes: 20 additions & 20 deletions docs/install/command-line.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Kubo
description: Using IPFS Kubo through the command-line allows you to do everything that IPFS Desktop can do, but at a more granular level, since you can specify which commands to run. Learn how to install it here.
current-ipfs-version: v0.31.0
current-ipfs-version: v0.32.0
---

# Install IPFS Kubo
Expand Down Expand Up @@ -31,7 +31,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t

Note the following:
- The amount of disk space your IPFS installation uses depends on how much data you're sharing. A base installation uses around 12MB of disk space.
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.31.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.32.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.


<!-- TODO: hide this footgun until https://github.com/ipfs/kubo/pull/10524 is merged and released in stable kubo
Expand Down Expand Up @@ -76,27 +76,27 @@ For installation instructions for your operating system, select the appropriate
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```powershell
wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_windows-amd64.zip -Outfile kubo_v0.31.0.zip
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_windows-amd64.zip -Outfile kubo_v0.32.0.zip
```

1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.31.0`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.0`.

```powershell
Expand-Archive -Path kubo_v0.31.0.zip -DestinationPath ~\Apps\kubo_v0.31.0
Expand-Archive -Path kubo_v0.32.0.zip -DestinationPath ~\Apps\kubo_v0.32.0
```

1. Move into the `kubo_v0.31.0` folder
1. Move into the `kubo_v0.32.0` folder

```powershell
cd ~\Apps\kubo_v0.31.0\kubo
cd ~\Apps\kubo_v0.32.0\kubo
```

1. Check that the `ipfs.exe` works:

```powershell
.\ipfs.exe --version
> ipfs version 0.31.0
> ipfs version 0.32.0
```

At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
Expand Down Expand Up @@ -142,7 +142,7 @@ For installation instructions for your operating system, select the appropriate
```powershell
ipfs --version
> ipfs version 0.31.0
> ipfs version 0.32.0
```

:::
Expand Down Expand Up @@ -170,7 +170,7 @@ For installation instructions for your operating system, select the appropriate
If Kubo is installed, the version number displays. For example:

```bash
> ipfs version 0.31.0
> ipfs version 0.32.0
```
:::

Expand All @@ -181,13 +181,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the Linux binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.31.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.32.0_linux-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -216,7 +216,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.31.0
> ipfs version 0.32.0
```

:::
Expand All @@ -228,13 +228,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the FreeBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_freebsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.31.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.32.0_freebsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -263,7 +263,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.31.0
> ipfs version 0.32.0
```

:::
Expand All @@ -275,13 +275,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the OpenBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_openbsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.31.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.32.0_openbsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.31.0
> ipfs version 0.32.0
```

:::
Expand All @@ -322,7 +322,7 @@ For installation instructions for your operating system, select the appropriate

## Build Kubo from source

For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.31.0/README.md#build-from-source) section in the Kubo repository.
For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.32.0/README.md#build-from-source) section in the Kubo repository.

## Determining which node to use with the command line

Expand Down
108 changes: 54 additions & 54 deletions docs/reference/kubo/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.

# Kubo command-line

::: tip Generated on 2024-10-17 13:53:14, from kubo 0.31.0
This document was autogenerated from CLI help text in [kubo 0.31.0](https://github.com/ipfs/kubo/releases/tag/v0.31.0)
::: tip Generated on 2024-11-14 02:07:48, from kubo 0.32.0
This document was autogenerated from CLI help text in [kubo 0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0)
For issues and support, check out the [generate-cli-docs.sh](https://github.com/ipfs/ipfs-docs/blob/main/docs/reference/kubo/generate-cli-docs.sh) script on GitHub.
:::

Expand Down Expand Up @@ -1087,12 +1087,25 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'announce-on':
Re-enables Reprovide system (reverts announce-off profile).
'randomports':
Use a random port number for swarm.
'legacy-cid-v0':
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'announce-off':
Disables Reprovide system (and announcing to Amino DHT).
USE WITH CAUTION:
The main use case for this is setups with manual Peering.Peers config.
Data from this node will not be announced on the DHT. This will make
DHT-based routing an data retrieval impossible if this node is the only
one hosting it, and other peers are not already connected to it.
'default-datastore':
Configures the node to use the default datastore (flatfs).
Read the "flatfs" profile description for more information on this datastore.
This profile may only be applied when first initializing the node.
'pebbleds':
Configures the node to use the pebble high-performance datastore.
Expand All @@ -1112,49 +1125,28 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile pebbleds'
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'test-cid-v1':
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'default-datastore':
Configures the node to use the default datastore (flatfs).
Read the "flatfs" profile description for more information on this datastore.
This profile may only be applied when first initializing the node.
'badgerds':
Configures the node to use the legacy badgerv1 datastore.
NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
Other caveats:
* This datastore will not properly reclaim space when your datastore is
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
on storing very little data in your IPFS node, and disk usage is more
critical than performance, consider using flatfs.
* This datastore uses up to several gigabytes of memory.
* Good for medium-size datastores, but may run into performance issues
if your dataset is bigger than a terabyte.
See configuration documentation at:
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile badgerds'
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'announce-on':
Re-enables Reprovide system (reverts announce-off profile).
'randomports':
Use a random port number for swarm.
'legacy-cid-v0':
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'flatfs':
Configures the node to use the flatfs datastore.
Expand All @@ -1175,19 +1167,27 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile flatfs'
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'badgerds':
Configures the node to use the legacy badgerv1 datastore.
'announce-off':
Disables Reprovide system (and announcing to Amino DHT).
NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
USE WITH CAUTION:
The main use case for this is setups with manual Peering.Peers config.
Data from this node will not be announced on the DHT. This will make
DHT-based routing an data retrieval impossible if this node is the only
one hosting it, and other peers are not already connected to it.
Other caveats:
* This datastore will not properly reclaim space when your datastore is
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
on storing very little data in your IPFS node, and disk usage is more
critical than performance, consider using flatfs.
* This datastore uses up to several gigabytes of memory.
* Good for medium-size datastores, but may run into performance issues
if your dataset is bigger than a terabyte.
See configuration documentation at:
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile badgerds'
SUBCOMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/kubo/rpc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
-->

::: tip Generated on 2024-10-17, from kubo v0.31.0
This document was autogenerated from [v0.31.0](https://github.com/ipfs/kubo/releases/tag/v0.31.0).
::: tip Generated on 2024-11-14, from kubo v0.32.0
This document was autogenerated from [v0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0).
For issues and support, check out the [http-api-docs](https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs) generator on GitHub.
:::

Expand Down
Loading

0 comments on commit e5e33e4

Please sign in to comment.