Skip to content

Commit 686ef16

Browse files
Mayank Pandeygitbook-bot
Mayank Pandey
authored andcommitted
GITBOOK-232: No subject
1 parent 1f17233 commit 686ef16

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

backup-and-restore.md

+28-5
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,43 @@ description: How to backup and restore Boost
44

55
# Backup and Restore
66

7-
### Backup
7+
## Backup
8+
9+
Boost now supports both online and offline backups. The backup command will output a backup directory containing the following files.
10+
11+
1. `metadata` - contains backup of leveldb
12+
2. `boostd.db` - backup of deals database
13+
3. `keystore` - directory containing libp2p keys
14+
4. `token` - API token
15+
5. `config` - directory containing all config files and `config.toml` link
16+
6. `storage.json` - file containing storage details
17+
18+
Backup does not backs up the deal logs and dagstore.
19+
20+
### Online backup
21+
22+
You can take an online backup with the below command
23+
24+
```
25+
boostd backup <backup directory>
26+
```
27+
28+
The online backup supports running only once instance at a time and you might see a locking error if another instance of backup is already running.
29+
30+
### Offline backup
831

932
1. Shutdown `boostd` before taking a backup
1033
2. Take a backup using the command line
1134

1235
```
13-
boostd backup <backup directory>
36+
boostd backup --offline <backup directory>
1437
```
1538

1639
{% hint style="info" %}
17-
Boost backup does not include dagstore and user can copy dagstore directory to a bckup location manually. Dagstore can be reinitialized if there is no backup.
40+
Boost offline backup does not include Dagstore and user can copy dagstore directory to a backup location manually. Dagstore can be reinitialized if there is no backup.
1841
{% endhint %}
1942

20-
### Restore
43+
## Restore
2144

2245
1. Make sure that `--boost-repo` flag is set if you wish to restore to a custom location. Otherwise, it will be restored to `~/.boost` directory
2346
2. Restore the boost repo using the command line
@@ -27,5 +50,5 @@ boostd restore <backup directory>
2750
```
2851

2952
{% hint style="info" %}
30-
Once restore is complete, dagstore can be manually copied inside the boost repo to restore it.
53+
Once restore is complete, Dagstore can be manually copied inside the boost repo to restore it.
3154
{% endhint %}

0 commit comments

Comments
 (0)