Skip to content

Commit a2596c4

Browse files
authored
Merge pull request #164 from ipfs-cluster/release/v1.1.3
Update to v1.1.3
2 parents 29a09a0 + 75f6d77 commit a2596c4

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

.github/workflows/deploy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ jobs:
88
container:
99
image: ipfs/ci-websites
1010
steps:
11-
- uses: actions/checkout@v2
11+
- uses: actions/checkout@v4
1212
- name: Build
1313
run: make build
14-
- uses: actions/upload-artifact@v3
14+
- uses: actions/upload-artifact@v4
1515
with:
1616
name: website
1717
path: public
@@ -34,7 +34,7 @@ jobs:
3434
CIRCLE_PROJECT_USERNAME: ipfs-cluster
3535
CIRCLE_PROJECT_REPONAME: ipfs-cluster-website
3636
steps:
37-
- uses: actions/download-artifact@v3
37+
- uses: actions/download-artifact@v4
3838
with:
3939
name: website
4040
path: /tmp/workspace

content/documentation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ aliases = [
1111

1212
# Documentation
1313

14-
<div class="tipbox tip">Updated to version <a href="https://github.com/ipfs-cluster/ipfs-cluster/blob/master/CHANGELOG.md">1.1.2 (see the Changelog)</a>.</div>
14+
<div class="tipbox tip">Updated to version <a href="https://github.com/ipfs-cluster/ipfs-cluster/blob/master/CHANGELOG.md">1.1.3 (see the Changelog)</a>.</div>
1515

1616
Welcome to IPFS Cluster documentation. The different sections of the documentation will explain how to setup, start, and operate a Cluster. Operating a production IPFS Cluster can be a daunting task if you are not familiar with concepts around [IPFS](https://ipfs.io) and peer-2-peer networking ([libp2p](https://libp2p.io) in particular). We aim to provide comprehensive documentation and guides but we are always open for improvements: documentation issues can be submitted to the [ipfs-cluster-website repository](https://github.com/ipfs-cluster/ipfs-cluster-website).
1717

content/documentation/collaborative/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A summarized version of the instructions for a single peer with default configur
2727
$ ipfs-cluster-service init --consensus crdt
2828
$ ipfs-cluster-service daemon
2929
# Write down:
30-
# - The generated cluster secret (will need to be re-used in other peers)
30+
# - The generated cluster secret (will need to be reused in other peers)
3131
# - The peer ID (this will be a "trusted peer")
3232
# - The multiaddress on which it will be reachable by other peers (usually /ip4/public_ip/tcp/9096/p2p/peer_id
3333
```

content/documentation/guides/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Cluster peers regularly broadcast (using gossipsub) metrics between each others.
1515

1616
The metrics are produced by ["informer" components](../../reference/configuration/#the-informer-section). There are currently several types of metrics:
1717

18-
* `ping`: the lack of pings from a given cluster peer signifies that the peer is down and is used to trigger re-pinnings when enabled. The ping metric includes information about each peer, like its peer name, IPFS daemon ID and addresses etc. which are then re-used to fill-in fields in the pin status objects when requested.
18+
* `ping`: the lack of pings from a given cluster peer signifies that the peer is down and is used to trigger re-pinnings when enabled. The ping metric includes information about each peer, like its peer name, IPFS daemon ID and addresses etc. which are then reused to fill-in fields in the pin status objects when requested.
1919
* `freespace`: this metric informs how much free space IPFS has in its repository and is used to decide whether to allocate new pins to this peer or others.
2020
* `tag:*`: "tag" metric provide values coming from the tag informer. For example, peer may broadcast a metric `tag:group` with value `server`. The values are used by the balanced allocator to distribute pins across different values of a single tag.
2121
* `pinqueue`: this metric carries the number of items queued to pin and can also be used to avoid pinning on peers with long pinning queues.

content/documentation/guides/security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ As explained above, the *shared secret* controls authorization by locking this e
6161

6262
### HTTP API and IPFS Pinning Service API endpoints
6363

64-
IPFS Cluster peers provide by default an **HTTP API endpoint** and an **IPFS Pinning Service API endpoint** which can be configured with SSL. It also provides a **libp2p API endpoint** for each, which re-uses either the Cluster libp2p host or a specifically configured libp2p host.
64+
IPFS Cluster peers provide by default an **HTTP API endpoint** and an **IPFS Pinning Service API endpoint** which can be configured with SSL. It also provides a **libp2p API endpoint** for each, which reuses either the Cluster libp2p host or a specifically configured libp2p host.
6565

6666
These endpoints are controlled by the `*.http_listen_multiaddress` (default `/ip4/127.0.0.1/tcp/9094`) and the `*.libp2p_listen_multiaddress` (if a specific `private_key` and `id` are configured in the `restapi/pinsvcapi` sections).
6767

68-
Note that when no additional libp2p host is configured and running in Raft mode, the Cluster's peer libp2p host (which listens on `0.0.0.0`) is re-used to provide the libp2p API endpoint. As explained, this endpoint is only protected by the *cluster secret*. When running in CRDT mode, the libp2p endpoint is disabled, as the cluster secret may be shared and would otherwise expose an open endpoint to the world. In order to run a lib2p API endpoint when using CRDT mode, configure an additional, separate libp2p host in the `restapi` configuration.
68+
Note that when no additional libp2p host is configured and running in Raft mode, the Cluster's peer libp2p host (which listens on `0.0.0.0`) is reused to provide the libp2p API endpoint. As explained, this endpoint is only protected by the *cluster secret*. When running in CRDT mode, the libp2p endpoint is disabled, as the cluster secret may be shared and would otherwise expose an open endpoint to the world. In order to run a lib2p API endpoint when using CRDT mode, configure an additional, separate libp2p host in the `restapi` configuration.
6969

7070
Both endpoints support **Basic Authentication** but are unauthenticated by default.
7171

content/documentation/reference/ctl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Note that unless `--force-http` is passed, using `basic-auth` is only supported
5252

5353
### Using the libp2p API endpoint
5454

55-
Since `0.3.5`, IPFS Cluster provides a libp2p endpoint for the HTTP API which provides channel security without the need to configure SSL certificates, by either re-using the peer's libp2p host or by setting up a new one with the given parameters in the API configuration.
55+
Since `0.3.5`, IPFS Cluster provides a libp2p endpoint for the HTTP API which provides channel security without the need to configure SSL certificates, by either reusing the peer's libp2p host or by setting up a new one with the given parameters in the API configuration.
5656

5757
In order to have `ipfs-cluster-ctl` use a libp2p endpoint, provide the `--host` flag as follows:
5858

content/news/0.8.0_release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ IPFS Cluster 0.8.0 comes out today and includes a revamp of the IPFS Proxy
1818
endpoint. We have promoted it to be its own API-type component, extracting it
1919
from the IPFS Connector (which is just the client to IPFS). We have
2020
additionally made improvements so that it truly mimics IPFS, by dynamically
21-
extracting headers from the real daemon that can be re-used in the responses
21+
extracting headers from the real daemon that can be reused in the responses
2222
handled by Cluster. Thus, there will be no CORS-related breakage when swapping
2323
out IPFS for Cluster, and custom IPFS headers (i.e. `X-Ipfs-Gateway`) can be
2424
configured and forwarded by the proxy.

0 commit comments

Comments
 (0)