Skip to content

Commit 876a281

Browse files
committed
chore: add callouts and locale updates
1 parent cf6e07e commit 876a281

4 files changed

Lines changed: 162 additions & 63 deletions

File tree

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

Lines changed: 35 additions & 0 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:
@@ -44,6 +55,11 @@ $ 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 \
@@ -62,6 +78,12 @@ 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
6688
$ gcloud storage cp gs://archive.hiro.so/mainnet/stacks-blockchain/mainnet-stacks-blockchain-latest.tar.zst .
6789
```
@@ -116,11 +138,24 @@ SHA256 checksum files are available for **all archives** to verify download inte
116138
```
117139

118140
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+
119147
```terminal
120148
$ echo "$(cat mainnet-stacks-blockchain-latest.sha256 | awk '{print $1}') mainnet-stacks-blockchain-latest.tar.zst" | shasum -a 256 -c
121149
```
122150

123151
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+
124159
```terminal
125160
$ tar -I zstd -xvf mainnet-stacks-blockchain-latest.tar.zst
126161
```

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.

0 commit comments

Comments
 (0)