Documentation ¶
Overview ¶
Package restic gives a (very brief) introduction to the structure of source code.
Overview ¶
The packages are structured so that cmd/ contains the main package for the restic binary, and internal/ contains almost all code in library form. We've chosen to use the internal/ path so that the packages cannot be imported by other programs. This was done on purpose, at the moment restic is a command-line program and not a library. This may be revisited at a later point in time.
Directories ¶
Path | Synopsis |
---|---|
cmd
|
|
restic
This package contains the code for the restic executable.
|
This package contains the code for the restic executable. |
helpers
|
|
internal
|
|
archiver
Package archiver contains the code which reads files, splits them into chunks and saves the data to the repository.
|
Package archiver contains the code which reads files, splits them into chunks and saves the data to the repository. |
backend
Package backend provides local and remote storage for restic repositories.
|
Package backend provides local and remote storage for restic repositories. |
backend/gs
Package gs provides a restic backend for Google Cloud Storage.
|
Package gs provides a restic backend for Google Cloud Storage. |
backend/local
Package local implements repository storage in a local directory.
|
Package local implements repository storage in a local directory. |
backend/location
Package location implements parsing the restic repository location from a string.
|
Package location implements parsing the restic repository location from a string. |
backend/sema
Package sema implements semaphores.
|
Package sema implements semaphores. |
backend/sftp
Package sftp implements repository storage in a directory on a remote server via the sftp protocol.
|
Package sftp implements repository storage in a directory on a remote server via the sftp protocol. |
backend/test
Package test contains a test suite with benchmarks for restic backends.
|
Package test contains a test suite with benchmarks for restic backends. |
crypto
Package crypto provides all cryptographic operations needed in restic.
|
Package crypto provides all cryptographic operations needed in restic. |
debug
Package debug provides an infrastructure for logging debug information and breakpoints.
|
Package debug provides an infrastructure for logging debug information and breakpoints. |
errors
Package errors provides custom error types used within restic.
|
Package errors provides custom error types used within restic. |
filter
Package filter implements filters for files similar to filepath.Glob, but in contrast to filepath.Glob a pattern may specify directories.
|
Package filter implements filters for files similar to filepath.Glob, but in contrast to filepath.Glob a pattern may specify directories. |
fs
Package fs implements an OS independent abstraction of a file system suitable for backup purposes.
|
Package fs implements an OS independent abstraction of a file system suitable for backup purposes. |
migrations
Package migrations contains migrations that can be applied to a repository and/or backend.
|
Package migrations contains migrations that can be applied to a repository and/or backend. |
repository
Package repository implements a restic repository on top of a backend.
|
Package repository implements a restic repository on top of a backend. |
repository/pack
Package pack provides functions for combining and parsing pack files.
|
Package pack provides functions for combining and parsing pack files. |
restic
Package restic is the top level package for the restic backup program, please see https://github.com/restic/restic for more information.
|
Package restic is the top level package for the restic backup program, please see https://github.com/restic/restic for more information. |
restorer
Package restorer contains code to restore data from a repository.
|
Package restorer contains code to restore data from a repository. |
test
Package test provides helper functions for writing tests for restic.
|
Package test provides helper functions for writing tests for restic. |
textfile
Package textfile allows reading files that contain text.
|
Package textfile allows reading files that contain text. |
Click to show internal directories.
Click to hide internal directories.