Skip to content

Commit a11caa5

Browse files
bgridleyryanwaits
andauthored
Devops 2014 (#1109)
* chore(archive): Update documents for extracting archives hirosystems/devops#2014 * chore(archive): Update documents for extracting archives hirosystems/devops#2014 * chore: add callouts and locale updates --------- Co-authored-by: Ryan Waits <ryan.waits@gmail.com>
1 parent e7e5a3e commit a11caa5

3 files changed

Lines changed: 136 additions & 37 deletions

File tree

content/docs/en/resources/archive/download-guide.mdx

Lines changed: 52 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ Before downloading, ensure you have sufficient:
1616

1717
## Download methods
1818

19+
:::callout
20+
type: warn
21+
### Archive Format Update: .tar.gz → .tar.zst
22+
We are transitioning all Hiro archive downloads from gzip (.tar.gz) to the more efficient Zstandard (.tar.zst) format. Going forward, newly published archives will use the .zst extension. Older backups will continue to be available in .tar.gz.
23+
24+
**What this means for you:**
25+
- Update any scripts or automation to download `*.tar.zst` instead of `*.tar.gz`.
26+
- Extracting `.zst` archives requires zstd support (e.g., `tar -I zstd -xvf archive.tar.zst`).
27+
- `.tar.gz` examples are still provided below for backward compatibility.
28+
:::
29+
1930
### Method 1: wget with resume (Recommended for most users)
2031

2132
The `wget` command with the `-c` flag enables resuming interrupted downloads:
@@ -27,8 +38,8 @@ You may need to install wget first: `brew install wget`. Alternatively, use the
2738
:::
2839

2940
```terminal
30-
$ wget -c https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz
31-
$ wget -c --progress=bar:force:noscroll https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz
41+
$ wget -c https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst
42+
$ wget -c --progress=bar:force:noscroll https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst
3243
```
3344

3445
**Advantages:**
@@ -44,11 +55,16 @@ $ wget -c --progress=bar:force:noscroll https://archive.hiro.so/mainnet/stacks-b
4455

4556
Use `curl` with automatic retries for robust downloads. The `--continue-at -` flag resumes partial downloads, while `--output` specifies the filename:
4657

58+
:::callout
59+
### Archive format update
60+
This example uses `.tar.zst` for the new format. For all new backups, use `.zst`. For older backups, replace `.zst` with `.gz` and use `--output file.tar.gz`.
61+
:::
62+
4763
```terminal
4864
$ curl --continue-at - --retry 10 --retry-delay 5 --retry-max-time 0 \
4965
--progress-bar \
50-
--output mainnet-stacks-blockchain-latest.tar.gz \
51-
https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz
66+
--output mainnet-stacks-blockchain-latest.tar.zst \
67+
https://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst
5268
```
5369

5470
**Advantages:**
@@ -62,14 +78,24 @@ Google Cloud CLI provides the fastest download speeds with parallel transfers. F
6278

6379
#### Download file to current directory
6480

81+
:::callout
82+
type: warn
83+
### Legacy archive format
84+
Most new archives are published in `.tar.zst`. Use `.tar.gz` only when accessing older snapshots.
85+
:::
86+
6587
```terminal
66-
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz .
88+
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst .
6789
```
6890

69-
#### OR stream directly to extraction (saves disk space but slower due to sequential download)
91+
#### OR stream directly to extraction (saves disk space but slower due to sequential download, zst extension requires zstd installed)
7092

7193
```terminal
72-
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz - | tar -xz
94+
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst - | tar -I zstd -xv
95+
```
96+
Or for older backups with the tar.gz extention:
97+
```terminal
98+
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.gz - | tar -zxv
7399
```
74100

75101
**Advantages:**
@@ -112,11 +138,28 @@ SHA256 checksum files are available for **all archives** to verify download inte
112138
```
113139

114140
2. **Verify the download:**
141+
142+
:::callout
143+
### Legacy checksum
144+
Checksum verification for `.tar.gz` is provided for users downloading older backups. Use the `.zst` checksum example for all current and future archives.
145+
:::
146+
115147
```terminal
116-
$ echo "$(cat mainnet-stacks-blockchain-latest.sha256 | awk '{print $1}') mainnet-stacks-blockchain-latest.tar.gz" | shasum -a 256 -c
148+
$ echo "$(cat mainnet-stacks-blockchain-latest.sha256 | awk '{print $1}') mainnet-stacks-blockchain-latest.tar.zst" | shasum -a 256 -c
117149
```
118150

119-
3. **Extract the archive:**
151+
3. **Extract the archive (requires zstd-tool to be installed):**
152+
153+
:::callout
154+
type: tip
155+
### Using older backups?
156+
If you are working with a legacy `.tar.gz` archive, use the extraction command below. All new archives are distributed as `.tar.zst`, which requires zstd support (`tar -I zstd`).
157+
:::
158+
159+
```terminal
160+
$ tar -I zstd -xvf mainnet-stacks-blockchain-latest.tar.zst
161+
```
162+
Or for older backups with the tar.gz extention:
120163
```terminal
121164
$ tar -zxvf mainnet-stacks-blockchain-latest.tar.gz -C /target/directory
122165
```

content/docs/es/resources/archive/download-guide.mdx

Lines changed: 83 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

idioma.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)