mirror of
https://github.com/kopia/kopia.git
synced 2026-01-06 05:27:59 -05:00
docs(site): Reordering side and top menus (#2130)
* docs(site): Reordering side menu * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Create _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update config.toml * Update _index.md
This commit is contained in:
basldfalksjdf
@@ -30,6 +30,12 @@ pygmentsStyle = "tango"
|
||||
# First one is picked as the Twitter card image if not set on page.
|
||||
#images = ["images/project-illustration.png"]
|
||||
|
||||
# Top Menu
|
||||
[[menu.main]]
|
||||
name = "Download Kopia Now!"
|
||||
weight = 1
|
||||
url = "https://kopia.io/docs/installation/"
|
||||
|
||||
# Configure how URLs look like per section.
|
||||
[permalinks]
|
||||
blog = "/:section/:year/:month/:day/:slug/"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Contribution Guidelines"
|
||||
linkTitle: "Contribution Guidelines"
|
||||
weight: 100
|
||||
toc_hide: true
|
||||
---
|
||||
|
||||
> NOTE: Those guidelines are preliminary and will change as the project grows and expands in scope.
|
||||
|
||||
39
site/content/docs/FAQs/_index.md
Normal file
39
site/content/docs/FAQs/_index.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Frequently Asked Questions"
|
||||
linkTitle: "Frequently Asked Questions"
|
||||
weight: 4
|
||||
---
|
||||
|
||||
> NOTE: This page is under development. Feel free to contribute as you see fit.
|
||||
|
||||
**Is your question not answered here? Please ask in the [Kopia discussion forums](https://kopia.discourse.group/) for help!**
|
||||
|
||||
##### What is a Snapshot?
|
||||
|
||||
A `snapshot` is a [point-in-time backup](../features#backup-files-and-directories-using-snapshots) of your files/directories; each snapshot contains the files/directories that you can [restore when you need to](../features#restore-snapshots-using-multiple-methods).
|
||||
|
||||
##### What is a Repository?
|
||||
|
||||
A `repository` is the storage location where your snapshots are saved; Kopia supports [cloud/remote, network, and local storage locations](../features#save-snapshots-to-cloud-network-or-local-storage) and all repositories are [encrypted](../features/#end-to-end-zero-knowledge-encryption) with a passphrase that you designate.
|
||||
|
||||
See the [repository help docs](../repository) for more information.
|
||||
|
||||
##### What is a Policy?
|
||||
|
||||
A `policy` is a set of rules that tells Kopia how to create/manage snapshots; this includes features such as [compression, snapshot retention, and scheduling when to take automatically snapshots](../features#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots).
|
||||
|
||||
##### How to Restore Files/Directories?
|
||||
|
||||
Files/directories are restored from the snapshots you create. To restore the data you backed up in a snapshot, Kopia gives you three options:
|
||||
|
||||
* mount the contents of a snapshot as a local disk so that you can browse and copy files/directories from the snapshot as if the snapshot is a local directory on your machine;
|
||||
|
||||
* restore all files/directories contained in a snapshot to any local or network location that you designate;
|
||||
|
||||
* or selectively restore individual files from a snapshot.
|
||||
|
||||
The [Getting Started Guide](../getting-started/) provides directions on how to restore files/directions [when using Kopia GUI](../getting-started/#restoring-filesdirectories-from-snapshots) and [when using Kopia CLI](../getting-started/#mounting-snapshots-and-restoring-filesdirectories-from-snapshots).
|
||||
|
||||
##### What is a Kopia Repository Server?
|
||||
|
||||
See the [Kopia Repository Server help docs](../repository-server) for more information.
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Features"
|
||||
linkTitle: "Features"
|
||||
weight: 30
|
||||
weight: 1
|
||||
---
|
||||
|
||||
### Backup Files and Directories using Snapshots
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
|
||||
---
|
||||
title: "Getting Started"
|
||||
linkTitle: "Getting Started"
|
||||
weight: 10
|
||||
title: "Getting Started Guide"
|
||||
linkTitle: "Getting Started Guide"
|
||||
weight: 3
|
||||
---
|
||||
|
||||
This guide will walk you through installing Kopia and setting up Kopia to backup/restore your data. Make sure to familiarize yourself with Kopia [features](../features/) before following this guide, so that you understand the appropriate terminology. As a reminder:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Download & Installation"
|
||||
linkTitle: "Download & Installation"
|
||||
weight: 20
|
||||
weight: 2
|
||||
---
|
||||
|
||||
### Two Variants of Kopia
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Mounting"
|
||||
linkTitle: "Mounting"
|
||||
weight: 50
|
||||
toc_hide: true
|
||||
---
|
||||
|
||||
Mounting allows you to map a content in Kopia repository into a directory in local filesystem and examine it using regular file commands or browser. This is currently the recommended way of restoring files from snapshots.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Privacy Policy"
|
||||
linkTitle: "Privacy Policy"
|
||||
weight: 999
|
||||
toc_hide: true
|
||||
---
|
||||
|
||||
Kopia respects the respect the privacy of our visitors.
|
||||
@@ -58,4 +58,4 @@ We use a tool called “Google Analytics” to collect information about use of
|
||||
|
||||
### Automatic Software Updates
|
||||
|
||||
Kopia application will periodically connect to `github.com` website to download information about the latest available version. No personal information is transferred in the process.
|
||||
Kopia application will periodically connect to `github.com` website to download information about the latest available version. No personal information is transferred in the process.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Reference"
|
||||
linkTitle: "Reference"
|
||||
weight: 90
|
||||
title: "Command-Line References"
|
||||
linkTitle: "Command-Line References"
|
||||
weight: 5
|
||||
---
|
||||
|
||||
* [Go API Reference](go-api/)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Repositories"
|
||||
linkTitle: "Repositories"
|
||||
weight: 40
|
||||
toc_hide: true
|
||||
---
|
||||
|
||||
A repository is a place where Kopia stores its snapshot data. Kopia currently supports the following storage backends:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Repository Server"
|
||||
linkTitle: "Repository Server"
|
||||
weight: 44
|
||||
toc_hide: true
|
||||
---
|
||||
|
||||
By default, every user of Kopia repository directly connects to an underlying storage using read-write access. If the users who share repository don't completely trust each other, some malicious actors can delete repository data structures causing data loss for others.
|
||||
|
||||
@@ -1,16 +1,18 @@
|
||||
---
|
||||
title: "Upgrade"
|
||||
linkTitle: "Upgrade"
|
||||
weight: 21
|
||||
title: "Upgrading to New Version"
|
||||
linkTitle: "Upgrading to New Version"
|
||||
weight: 7
|
||||
---
|
||||
|
||||
### Upgrading Kopia to v0.9
|
||||
Upgrading Kopia from one version to the next is a seamless process except for the upgrade paths discussed in this document. If your Kopia upgrade path is not mentioned here, then you are safe to upgrade Kopia as normal.
|
||||
|
||||
### Upgrading Kopia v0.8 and Earlier to Newer Version
|
||||
|
||||
Kopia v0.9 adds support for several new features thanks to a brand-new index format.
|
||||
|
||||
If your repository was created in a version older than v0.9, please follow the steps below to upgrade.
|
||||
|
||||
### Notes
|
||||
#### Notes
|
||||
|
||||
It is critical to follow the process outlined before exactly and to verify that during the upgrade steps no instance of `kopia` is connected to the repository.
|
||||
|
||||
@@ -24,7 +26,7 @@ This includes:
|
||||
Also note, that after the upgrade, kopia v0.8 and earlier will not be able to open the repository anymore. Once upgraded all new v0.9 features will be supported except password change, which is only
|
||||
available for newly-created repositories.
|
||||
|
||||
### Upgrade Process
|
||||
#### Upgrade Process
|
||||
|
||||
1. Select one kopia client that will perform the upgrade, if there are more clients, pick the one that is currently the owner of maintenance process, which is typically the client that first created the repository.
|
||||
|
||||
@@ -58,4 +60,4 @@ You should see `Format version: 2`
|
||||
|
||||
5. Reconnect kopia clients that were disconnected in step 2 and re-enable all disabled background jobs.
|
||||
|
||||
6. When in doubt, it's better not to guess, but post a question on https://kopia.discourse.group
|
||||
6. When in doubt, it's better not to guess, but post a question on https://kopia.discourse.group
|
||||
|
||||
@@ -1,11 +1,8 @@
|
||||
|
||||
---
|
||||
title: "Kopia"
|
||||
title: "What is Kopia?"
|
||||
linkTitle: "Documentation"
|
||||
weight: 20
|
||||
menu:
|
||||
main:
|
||||
weight: 20
|
||||
---
|
||||
|
||||
Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](features/#end-to-end-zero-knowledge-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](features/#save-snapshots-to-cloud-network-or-local-storage). Kopia does not 'image' your whole machine. Rather, Kopia allows you to backup/restore any and all files/directories that you deem are important or critical.
|
||||
|
||||
Reference in New Issue
Block a user