mirror of
https://github.com/garethgeorge/backrest.git
synced 2026-10-26 16:45:33 +00:00
64 lines
2.4 KiB
TypeScript
64 lines
2.4 KiB
TypeScript
import { Collapse, Divider, Spin, Typography } from "antd";
|
|
import React, { useEffect, useState } from "react";
|
|
import { backrestService } from "../api";
|
|
import { useConfig } from "../components/ConfigProvider";
|
|
import { Config } from "../../gen/ts/v1/config_pb";
|
|
|
|
export const GettingStartedGuide = () => {
|
|
const config = useConfig()[0];
|
|
|
|
return (
|
|
<>
|
|
<Typography.Text>
|
|
<h1>Getting Started</h1>
|
|
{/* open link in new tab */}
|
|
<p><a href="https://github.com/garethgeorge/backrest" target="_blank">Check for new Backrest releases on GitHub</a></p>
|
|
<Divider orientation="left">Overview</Divider>
|
|
<ul>
|
|
<li>
|
|
Repos map directly to restic repositories, start by configuring your
|
|
backup locations.
|
|
</li>
|
|
<li>
|
|
Plans are where you configure directories to backup, and backup
|
|
scheduling. Multiple plans can backup to a single restic repository.
|
|
</li>
|
|
<li>
|
|
See{" "}
|
|
<a href="https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html" target="_blank">
|
|
the restic docs on preparing a new repository
|
|
</a>{" "}
|
|
for details about available repository types and how they can be
|
|
configured.
|
|
</li>
|
|
<li>See <a href="https://garethgeorge.github.io/backrest" target="_blank">the Backrest wiki</a> for instructions on how to configure Backrest.</li>
|
|
</ul>
|
|
<Divider orientation="left">Tips</Divider>
|
|
<ul>
|
|
<li>
|
|
Backup your Backrest configuration: your Backrest config holds all of
|
|
your repos, plans, and the passwords to decrypt them. When you have
|
|
Backrest configured to your liking make sure to store a copy of your
|
|
config (or minimally a copy of your passwords) in a safe location
|
|
e.g. a secure note in your password manager.
|
|
</li>
|
|
</ul>
|
|
<Divider orientation="left">Config View</Divider>
|
|
<Collapse
|
|
size="small"
|
|
items={[
|
|
{
|
|
key: "1",
|
|
label: "Config JSON hidden for security",
|
|
children: config ? <Typography>
|
|
<pre>{config.toJsonString({
|
|
prettySpaces: 2,
|
|
})}</pre>
|
|
</Typography> : <Spin />,
|
|
},
|
|
]}
|
|
/>
|
|
</Typography.Text>
|
|
</>
|
|
);
|
|
}; |