Skip to content

Commit 8eba3a6

Browse files
committed
Update README and run.md guide
Make sure they are up to date to how things work right now.
1 parent 284bb04 commit 8eba3a6

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ ipfs repo version | go-ipfs versions
4141
1 | 0.0.0 - 0.2.3
4242
2 | 0.3.0 - 0.3.11
4343
3 | 0.4.0 - 0.4.2
44-
4 | 0.4.3 - current
44+
4 | 0.4.3 - 0.4.5
45+
5 | 0.4.6 - current
4546

4647
### How to Run Migrations
4748

run.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
# Running Repo Migrations
22

3-
How to run [fs-repo](https://github.com/ipfs/specs/tree/master/repo/fs-repo) migrations for [ipfs](https://github.com/ipfs/ipfs).
3+
This document explains how to run [fs-repo](https://github.com/ipfs/specs/tree/master/repo/fs-repo) migrations for [ipfs](https://github.com/ipfs/ipfs).
44

5-
We have changed the internal, on-disk format we use to store data. In order to avoid losing your data, we're taking extra care to provide a stable migration tool that upgrades old versions of the repo to the new ones. You'll need to run the migration if you find an error like this:
5+
Note that running migrations is a task automatically performed by the `ipfs` when starting the `ipfs` daemon after an upgrade or running the `ipfs-update` tool, so you would normally not need to run the `fs-repo-migrations` tool.
66

7-
```
8-
> ipfs daemon
9-
Error: ipfs repo found in old '.go-ipfs' location, please run migration tool.
10-
Please see https://github.com/ipfs/fs-repo-migrations/blob/master/run.md
11-
```
7+
The `fs-migrations-tool` comes into play when the internal, on-disk format `ipfs` uses to store data changes. In order to avoid losing data, this tool upgrades old versions of the repo to the new ones.
128

13-
Soon, we hope to run these entirely automatically. But for now, we ask you to run these manually in case something goes wrong. It's very easy. See the quick steps below. If you run into any trouble, please feel free to open an issue in this repository: [issues](https://github.com/ipfs/fs-repo-migrations/issues).
9+
If you run into any trouble, please feel free to [open an issue in this repository](https://github.com/ipfs/fs-repo-migrations/issues).
1410

1511
## Step 0. Back up your repo (optional)
1612

@@ -31,7 +27,7 @@ cp -r ~/.ipfs ~/.ipfs.bak
3127

3228
## Step 2. Run the Migration
3329

34-
Now, run the migration tool.
30+
Now, run the migration tool:
3531

3632
```sh
3733
# if you installed from Go, tool is in your global $PATH
@@ -41,11 +37,10 @@ fs-repo-migrations
4137
./fs-repo-migrations
4238
```
4339

44-
4540
## Step 3. Done! Run IPFS.
4641

4742
If the migration completed without error, then you're done! Try running the new ipfs:
4843

4944
```
50-
ipfs
45+
ipfs daemon
5146
```

0 commit comments

Comments
 (0)