Skip to content

document init-hot #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aawsome merged 1 commit into from
Mar 9, 2026
Merged

document init-hot #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions src/commands/init/cold_storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,41 @@ only pack files older than the given time will be removed.
Once you get a working configuration, please share it
[in the main repository](https://github.com/rustic-rs/rustic/tree/main/config/services)
so other users can use it as well!

### changing a normal repository into a hot/cold repository

Note: When changing a normal repository into a hot/cold repository, rustic uses
the normal repository as cold part; we therefore need to create the hot
repository part. This involves copying metadata from the normal repository to
the hot repository part. It is advised to do this before the cold part is
actually freezed, e.g. by changing storage tier or moving it to a cold location.

Here are the steps:

- Add a `repo-hot` configuration.
- Run `rustic init --hot-only`. This will copy over all metadata to the hot
repository part.
- Note that after these two steps, you already have a valid hot/cold repository
configuration where the cold part is not read by standard rustic commands. Try
it out by e.g. running `rustic check`!
- Manually freeze the complete cold repository part or copy it to another (cold)
storage (this may need to update the repository configuration).
- Add a suitable warm-up configuration.

### changing a hot/cold repository into a normal repository

This is rather simple, as the cold part of the repository already is a normal
repository which only needs to be warmed up. Here are the steps:

- Remove any warm-up configuration.
- Manually warm-up the complete cold repository part or copy it to another (hot)
storage (this may need to update the repository configuration).
- Note that after these first two steps, you still have a totally valid hot/cold
repository configuration. The "cold" part is not cold anymore, but will not be
read by standard rustic commands. You can test this e.g. by running
`rustic check`.
- Remove `repo-hot` and the according configuration from the repository
configuration.
- (optional) Remove the hot repository from its storage backend.

That's it! rustic will use the fully warmed-up repsitory as a normal repository.
22 changes: 12 additions & 10 deletions src/comparison-restic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ rustic and restic. Currently, we compare restic 0.18.1 with rustic 0.11.0.
| --------------------- | ------------------------- | ------------------------------------------------------ |
| programming language | Go | Rust |
| development philosopy | conservative with changes | moving fast, add new features early |
| test coverage | ✅ | ❌ (47% in rustic_core) |
| test coverage | ✅ | ❌ (52% in rustic_core) |
| available as library | ❌ | ✅ [rustic_core](https://crates.io/crates/rustic_core) |

## Core features introduced by rustic
Expand Down Expand Up @@ -41,6 +41,7 @@ introduced by rustic. Some have been already adopted by restic.
| `backup` multiple snapshots at once | ❌ | ✅ |
| `backup` support for block devices | ❌ | ✅ |
| `check` uses existing cache | ❌ (roadmap: 0.19) | ✅ |
| `check` only given snapshot(s) | ❌ | ✅ |
| show file history | ❌ | ✅ (`rustic find --path`) |
| more snapshot filter options | ❌ | ✅ (see below for details) |
| allow to log to file | ❌ | ✅ |
Expand Down Expand Up @@ -206,15 +207,16 @@ introduced by rustic. Some have been already adopted by restic.

### `init`

| option | `restic` | `rustic` |
| ----------------------- | ------------------------------ | -------------------------------- |
| `--copy-chunker-params` | ✅ | (not needed, use `copy --init`) |
| `--from-*` | ✅ | (not needed, see `copy` command) |
| `--hostname` | ❌ (always sets hostname) | ✅ |
| `--repository-version` | ✅ | ✅ (use `--set-version`) |
| `--set-*` | ❌ (no in-repo config support) | ✅ |
| `--username` | ❌ (always sets username) | ✅ |
| `--with-created` | ❌ (always sets creation time) | ✅ |
| option | `restic` | `rustic` |
| ----------------------- | -------------------------------- | -------------------------------- |
| `--copy-chunker-params` | ✅ | (not needed, use `copy --init`) |
| `--from-*` | ✅ | (not needed, see `copy` command) |
| `--hostname` | ❌ (always sets hostname) | ✅ |
| `--hot-only` | ❌ (no general hot/cold support) | ✅ |
| `--repository-version` | ✅ | ✅ (use `--set-version`) |
| `--set-*` | ❌ (no in-repo config support) | ✅ |
| `--username` | ❌ (always sets username) | ✅ |
| `--with-created` | ❌ (always sets creation time) | ✅ |

### `backup`

Expand Down