Compare commits

...

184 Commits
0.17 ... v1.1.1

Author SHA1 Message Date
a3239c0f3b changelog 2021-05-17 22:40:27 +02:00
90cd3171e5 docs 2021-05-17 22:40:23 +02:00
61673bd88b allow options for backend 2021-05-17 22:34:14 +02:00
41736ea3c4 typos 2021-05-07 11:34:46 +02:00
a7779e04bd Merge pull request #75 from FuzzyMistborn/patch-2
Update update command in docs
2021-05-07 11:31:26 +02:00
Fuzzy
1326e7e53c Update update command in docs 2021-05-06 23:05:34 -04:00
478e193d78 forgot version bump 2021-05-06 16:17:45 +02:00
11d4c67dce docs 2021-05-06 16:14:29 +02:00
1643309957 changelog 2021-05-06 15:57:28 +02:00
e05386b0b5 add failure and success hooks 2021-05-06 15:55:32 +02:00
aebaf0a225 Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2021-05-06 15:12:37 +02:00
c090013bf5 Update README.md 2021-05-06 15:12:11 +02:00
88c6949208 custom restic binary 2021-05-06 15:04:35 +02:00
9256cdc38c changelog 2021-05-01 22:57:01 +02:00
a8c611e8ce Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2021-05-01 22:54:57 +02:00
d4522c7ffe fix validation for docker volumes 2021-05-01 22:54:52 +02:00
21185d894e Update contrib.md 2021-05-01 17:25:50 +02:00
b119fc7ea5 Merge pull request #72 from themorlan/master
Correcting some typos in the Documentation
2021-05-01 17:25:20 +02:00
themorlan
73f4bcfd48 missing words in sentence 2021-05-01 15:18:05 +02:00
themorlan
3567319314 typo 2021-05-01 15:16:13 +02:00
themorlan
bf19c983d1 typo 2021-05-01 15:15:44 +02:00
themorlan
12e4de110b typo 2021-05-01 15:14:50 +02:00
c9f425ef64 docs on native flags 2021-04-30 10:47:29 +02:00
974f555dff Update contrib.md 2021-04-29 15:18:03 +02:00
1688c1f3c3 add brew docs 2021-04-29 15:16:33 +02:00
29e46d3b5c brew stuff 2021-04-29 14:45:17 +02:00
0335abb669 add sign 2021-04-28 14:51:56 +02:00
b2f9b9a54e typo 2021-04-28 13:50:11 +02:00
2b13a6e13d installtion docs 2021-04-28 13:44:20 +02:00
cc293ea256 Update installation.md 2021-04-28 13:38:20 +02:00
a4ddd5bbcb Update contrib.md 2021-04-28 13:34:58 +02:00
7cbf43b75d Update README.md 2021-04-28 11:13:16 +02:00
bae77c4673 Update README.md 2021-04-28 11:10:36 +02:00
12adeb2b06 changelog 2021-04-28 10:54:33 +02:00
37b26dfc31 consistent casing 2021-04-28 10:54:30 +02:00
c1795b2acc lean flag 2021-04-28 10:54:07 +02:00
b8d12e518c completion docs 2021-04-28 10:34:43 +02:00
50060cf539 explain verbose flag 2021-04-27 18:38:51 +02:00
c33aac42dc quickstart 2021-04-27 18:35:32 +02:00
c359053e0e Update contrib.md 2021-04-27 09:02:39 +02:00
c16340ab26 Update available.md 2021-04-27 09:01:01 +02:00
edc85c4ac3 Merge pull request #60 from david-boles/backblaze
Update Backblaze docs
2021-04-27 08:59:44 +02:00
68682777f2 Merge pull request #59 from david-boles/consistent-config-location
Recommend a consistent config location
2021-04-27 08:26:22 +02:00
David Boles
b6c7922df5 Recommend a consistent config location 2021-04-26 16:47:00 -07:00
David Boles
991b8bec22 Update backblaze docs 2021-04-26 16:38:08 -07:00
bbc32568ad parallel builds 2021-04-26 13:29:26 +02:00
f3c038c716 changelog & version bump 2021-04-26 13:18:02 +02:00
59612a97b6 Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2021-04-26 13:16:01 +02:00
33319a00ef add arm for darwin 2021-04-26 13:15:58 +02:00
8eb14ea14f Update quick.md 2021-04-25 11:19:39 +02:00
70eb9e441f add rclone support 2021-04-24 16:40:53 +02:00
be25af2d76 Merge pull request #53 from TheForcer/master
Fix typo in check output
2021-04-24 13:19:34 +02:00
1c436369f0 check folder 2021-04-24 12:40:33 +02:00
6efcce07b7 show error and exit with bad code if not found 2021-04-23 23:53:57 +02:00
Felix
dc6dd2e712 Fix typo in check output 2021-04-23 19:19:03 +02:00
Felix
68628d3776 Merge pull request #1 from cupcakearmy/master
Update
2021-04-23 19:18:08 +02:00
40988ef3b4 Update contrib.md 2021-04-23 17:53:48 +02:00
fad33fcdaa Merge pull request #51 from TheForcer/master
Fix typos in docs
2021-04-23 17:53:15 +02:00
Felix
8cf8a77558 Fix typos in docs 2021-04-23 17:45:02 +02:00
36998cfd3b changelog 2021-04-23 13:47:21 +02:00
cf03562ea2 docs 2021-04-23 13:45:54 +02:00
188560395d exclude items from config when empty and rest options 2021-04-23 13:11:15 +02:00
bacbd0f806 docs 2021-04-23 12:31:24 +02:00
93bf0388a4 add force flag description 2021-04-22 10:00:52 +02:00
ec8fdbd135 updated contrib list 2021-04-22 01:14:47 +02:00
420934489c Merge pull request #46 from FuzzyMistborn/patch-1
Fix typo in install script
2021-04-22 01:07:11 +02:00
Fuzzy
2ba767c8c3 Fix typo in install script
Fix typo
2021-04-21 14:32:11 -04:00
b489c662c7 docs 2021-04-21 09:41:14 +02:00
6862529a89 move envs to new format 2021-04-21 09:36:47 +02:00
aa96a95600 typos 2021-04-21 09:34:01 +02:00
89e32c298c update the quick guide 2021-04-21 09:27:35 +02:00
873170c6d1 fix auto update 2021-04-20 23:26:57 +02:00
ea82fea8e1 add cron tag 2021-04-20 20:49:09 +02:00
a35edcaea5 version bump 2021-04-17 20:55:09 +02:00
86d44eafad exit with better message 2021-04-17 20:51:40 +02:00
e927fd5a64 panic on already running 2021-04-17 20:45:52 +02:00
d5e13d4e27 changelog 2021-04-17 17:54:24 +02:00
824c90904c docs 2021-04-17 17:51:23 +02:00
58fb5e073a Update README.md 2021-04-17 17:50:53 +02:00
541a7c2a72 add autocompletetions 2021-04-17 17:48:31 +02:00
e671780e54 fix version upgrade 2021-04-17 17:41:53 +02:00
a5471efa21 check self update 2021-04-17 17:32:05 +02:00
769ae4c566 Merge pull request #44 from cupcakearmy/rewrite
Rewrite
2021-04-17 17:21:19 +02:00
f2934f60ae docs 2021-04-17 17:19:59 +02:00
f6bc91e9b5 merge 2021-04-17 17:16:58 +02:00
fb073627a8 Merge remote-tracking branch 'origin/master' into rewrite 2021-04-17 17:16:52 +02:00
976a3beab5 upgrade logic 2021-04-17 17:13:03 +02:00
ec2377287e docs 2021-04-17 17:04:43 +02:00
7b7eec2dba install script 2021-04-17 15:57:15 +02:00
33be94ba55 licensing 2021-04-17 15:12:44 +02:00
8f7513b103 v30 2021-04-17 14:49:29 +02:00
cf417e360d roadmap 2021-04-17 13:13:17 +02:00
b5caad2d70 docs 2021-04-17 13:12:25 +02:00
2e594cade6 docs 2021-04-17 13:12:20 +02:00
276c424106 pass env of backends to restic 2021-04-17 13:04:40 +02:00
b314912821 describe backends 2021-04-17 12:02:00 +02:00
b1054f3512 info command 2021-04-16 22:37:15 +02:00
1bbd3879fe make back compatible 2021-04-16 22:02:25 +02:00
aa0b81023f vercel 2021-04-16 00:31:34 +02:00
09e0ee4dec shorthand for config 2021-04-16 00:27:06 +02:00
952334fecb docs 2021-04-16 00:26:57 +02:00
a45eee6009 only when tagged 2021-04-15 23:36:01 +02:00
a658b6bb21 workflow 2021-04-15 23:35:00 +02:00
8e13e7bc40 linting 2021-04-15 23:16:47 +02:00
6449b8999f support for volume locations 2021-04-15 21:55:35 +02:00
7629626ae0 comment on major version 2021-04-15 01:08:56 +02:00
190eca6f6e check for mahor version for updates 2021-04-15 00:57:15 +02:00
da6d9c53aa docs 2021-04-12 16:41:46 +02:00
604354741e remove tmp file 2021-04-12 16:16:08 +02:00
3ccaee4066 cleaner output and ctrl-c 2021-04-12 16:15:17 +02:00
640b60c47f current state 2021-04-12 10:55:57 +02:00
d293e93fa8 cron job 2021-04-12 00:17:29 +02:00
03ca0c8677 add key if not present 2021-04-12 00:02:35 +02:00
19e75c1dad fixes 2021-04-11 18:17:21 +02:00
6e25b90915 unlock on error and named arrays for config 2021-04-11 17:02:34 +02:00
8a1fe41825 cron 2021-04-11 15:02:27 +02:00
5d92b5bcc1 dry run for forget cmd 2021-04-11 14:22:46 +02:00
05be58a3a7 restore cmd 2021-04-11 14:03:38 +02:00
9ba58ee7f8 decsriptions 2021-04-11 13:08:50 +02:00
335724cce7 progress 2021-04-11 13:04:11 +02:00
43244302be build file 2021-04-11 13:03:47 +02:00
03cbbfd91c go rewrite 2021-04-09 01:55:10 +02:00
805bed7db1 design 2021-04-08 21:05:34 +02:00
6c59aa25db lfs 2021-04-08 21:05:30 +02:00
ff648f0017 don't make autorestic return 1 on call 2021-01-24 10:27:37 +01:00
c79b45308b Create config.yml 2021-01-10 11:27:41 +01:00
43eabdb204 Update issue templates 2021-01-10 11:25:48 +01:00
0ead9e0da1 remove version from package 2020-12-19 17:32:13 +01:00
d49e0d3836 Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2020-12-09 00:07:45 +01:00
2008ba2771 changelog 2020-12-09 00:07:43 +01:00
1f6c13a595 fix locking issue 2020-12-09 00:07:03 +01:00
8e9b9dcebf Update README.md 2020-12-08 23:46:06 +01:00
fde4edc05f use version from package, stricter compiler 2020-11-29 15:37:39 +01:00
7e6cc7bb32 lock only if config required 2020-11-29 15:27:32 +01:00
878a7bd752 disable colors in ci mode 2020-11-16 17:30:32 +01:00
f6860115a3 remove ununsed log 2020-11-14 00:40:16 +01:00
f43e73ce41 process end in exit 2020-11-14 00:33:52 +01:00
6b4277b57b changelog 2020-11-13 21:47:33 +01:00
d4b8a7223f don't require config for update 2020-11-13 16:27:19 +01:00
cfcc010bc5 update some pkgs 2020-11-13 15:48:48 +01:00
1fd009b819 add ci mode 2020-11-13 15:48:40 +01:00
91e902d7ef docs 2020-11-13 15:48:20 +01:00
b690c1c3a9 correct link 2020-11-07 12:55:16 +01:00
b025aeeeab version bump 2020-11-07 12:50:05 +01:00
01cafb9436 Update README.md 2020-11-07 12:47:06 +01:00
6a2c34df48 vercel 2020-11-07 12:41:51 +01:00
88e47efc68 Merge pull request #30 from cupcakearmy/rewrite
Rewrite with commander & docs cleanup
2020-11-06 23:51:57 +01:00
60d7e0b561 rewrite with commander 2020-11-06 23:51:23 +01:00
e9a7e03af7 docs 2020-11-06 22:48:19 +01:00
d959a50b5a docs 2020-11-06 22:42:00 +01:00
b5bc1a4cee Merge pull request #27 from sumnerboy12/patch-1
fix typo on skipping/scheduled log message
2020-07-24 10:38:07 +02:00
Ben Jones
e61c940d23 fix typo on skipping/scheduled log message 2020-07-24 11:53:27 +12:00
7fb0fbd467 new version 2020-07-23 13:34:23 +02:00
cbc1b33750 docs 2020-07-23 13:33:14 +02:00
e7be01da37 Merge pull request #26 from sumnerboy12/patch-1
add support for rest server backends
2020-07-23 13:29:20 +02:00
Ben Jones
309073fe4d Update available.md 2020-07-23 23:26:31 +12:00
Ben Jones
1243721a7e add support for rest server backends
Backend configuration would be;

```
rest_repo:
  type: rest
  path: http://backup:8001/repo_name
```

Would result in the following env var;
```
RESTIC_REPOSITORY=rest:http://backup:8001/repo_name
```
2020-07-23 15:21:55 +12:00
ebb934d1c5 docs 2020-06-28 22:48:00 +02:00
8417a6e0aa update docs version 2020-06-28 22:47:46 +02:00
2b5efd0499 cron docs 2020-06-28 22:36:44 +02:00
af6e715b27 generate docs 2020-06-28 22:33:22 +02:00
9484299cd9 cron working now 2020-06-28 22:33:15 +02:00
ef93fef36a help for releasing 2020-06-25 09:36:17 +02:00
995f2250a1 version bump 2020-06-25 09:36:11 +02:00
3498e6da7b fix check for executable 2020-06-25 09:33:08 +02:00
7128983581 lock file 2020-06-25 09:21:33 +02:00
158407927a Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2020-06-25 09:17:23 +02:00
ea8bf83799 always unlock 2020-06-25 09:17:20 +02:00
e8a8ccccd0 use longer wrap length 2020-06-25 09:17:02 +02:00
b332897713 upgrade packages, included lock file, fixed types 2020-06-25 09:16:53 +02:00
369037ea77 Merge pull request #23 from jin-park-dev/feature/spell-fix
Feature/spell fix
2020-06-25 08:43:59 +02:00
Jin Park
52cd6fe3fd Fix e to E 2020-06-25 01:40:04 +01:00
Jin Park
b6f7ef6577 Minor spell fixes in doc 2020-06-25 01:23:31 +01:00
1a891fffbd funding 2020-05-26 10:31:59 +02:00
ed68160a9a Update README.md 2020-05-20 19:31:59 +02:00
20ecd21928 Update README.md 2020-05-20 19:30:48 +02:00
df6fd75ca4 Update README.md 2020-05-20 19:30:31 +02:00
c918fb6ded Update README.md 2020-05-20 19:30:05 +02:00
2bc8fe4ee7 logo 2020-05-20 19:26:13 +02:00
757a134362 default open 2020-05-17 19:04:44 +02:00
6bb36cbde0 docs 2020-05-17 18:56:14 +02:00
5c0b67b7fb version bump 2020-05-17 18:14:09 +02:00
1520e10a59 do not allow multiple instances 2020-05-17 18:13:50 +02:00
f9c645120b run in shell to set paths and find restic 2020-05-17 18:12:58 +02:00
146 changed files with 15874 additions and 4112 deletions

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
*.afdesign filter=lfs diff=lfs merge=lfs -text

1
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1 @@
github: cupcakearmy

21
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,21 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
<!-- A clear and concise description of what the bug is. -->
**Expected behavior**
<!-- A clear and concise description of what you expected to happen. -->
**Environment**
- OS: [e.g. iOS]
- Version: [e.g. 22]
**Additional context**
<!-- Add any other context about the problem here. -->

4
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,4 @@
contact_links:
- name: Questions & Help
url: https://github.com/cupcakearmy/autorestic/discussions
about: Please ask and answer questions here.

View File

@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. -->

BIN
.github/logo.afdesign (Stored with Git LFS) vendored Normal file

Binary file not shown.

BIN
.github/logo.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

28
.github/workflows/build.yml vendored Normal file
View File

@@ -0,0 +1,28 @@
name: Main
on:
push:
tags:
- 'v*.*.*'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: '^1.16.3'
- name: Build
run: go run build/build.go
- name: Sign
uses: tristan-weil/ghaction-checksum-sign-artifact@v1.0.1
with:
path: dist/*
- name: Release
uses: softprops/action-gh-release@v1
with:
files: dist/*
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

25
.gitignore vendored
View File

@@ -1,23 +1,12 @@
# Editors
.idea
# Node
node_modules/
package-lock.json
yarn.lock
# Build & Runtime
bin
lib
data
restore
docker
Dockerfile
.vscode
# Config
.autorestic.yml
.autorestic.lock
.docker.yml
.autorestic*
# Docs
.codedoc
# Build & Dev
test
autorestic
data
dist

View File

@@ -1,3 +0,0 @@
semi: false
singleQuote: true
trailingComma: 'es5'

View File

@@ -1,4 +1,95 @@
## 0.17
# Changelog
- new docs
- cron command
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.1.1] - 2021-05-17
### Added
- Options for backends
## [1.1.0] - 2021-05-06
### Added
- use custom restic binary
- success & failure hooks
### Fixed
- don't skip other locations on failure
## [1.0.9] - 2021-05-01
### Fixed
- Validation for docker volumes
## [1.0.8] - 2021-04-28
### Added
- `--lean` flag to cron command for less output about skipping backups.
### Fixed
- consistent lower casing in usage descriptions.
## [1.0.7] - 2021-04-26
### Added
- Support for `darwin/arm64` aka Apple Silicon.
- Added support for `arm64` and `aarch64` in install scripts.
## [1.0.6] - 2021-04-24
### Added
- Support for rclone
## [1.0.5] - 2021-04-24
### Fixed
- Correct exit code on backup failure and better logging/output/feedback.
- Check if `from` key is an actual directory.
## [1.0.4] - 2021-04-23
### Added
- Options to add rest username and password in config
### Fixed
- Don't add empty strings when saving config
## [1.0.3] - 2021-04-20
### Fixed
- Auto upgrade script was not working on linux as linux does not support writing to the binary that is being executed
## [1.0.2] - 2021-04-20
### Added
- Add the `cron` tag to backup to backups made with cron.
### Fixed
- Don't unlock lockfile if process is already running.
## [1.0.1] - 2021-04-17
### Added
- Completion command for various shells
## [1.0.0] - 2021-04-17
- Rewrite in go. See https://autorestic.vercel.app/upgrade for migration.

30
DEVELOPMENT.md Normal file
View File

@@ -0,0 +1,30 @@
# Development
## Coding
The easiest way (imo) is to run [`gowatch`](https://github.com/silenceper/gowatch) in a separate terminal and the simply run `./autorestic ...`. `gowatch` will watch the code and automatically rebuild the binary when changes are saved to disk.
## Building
```bash
go run build/build.go
```
This will build and compress binaries for multiple platforms. The output will be put in the `dist` folder.
## Releasing
Releases are automatically built by the github workflow and uploaded to the release.
1. Bump `VERSION` in `internal/config.go`.
2. Update `CHANGELOG.md`
3. Commit to master
4. Create a new release with the `v1.2.3` tag and mark as draft.
5. The Github action will build the binaries, upload and mark the release as ready when done.
### Brew
1. Download the latest release.
2. Check the checksum with `shasum -a 256 autorestic-1.2.3.tar.gz`
3. Update `url` and `sha256` in the brew repo.
4. Submit PR

215
LICENSE
View File

@@ -1,21 +1,202 @@
MIT License
Copyright (c) 2019 Nicco
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
1. Definitions.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@@ -1,6 +1,50 @@
# autorestic
High backup level CLI utility for [restic](https://restic.net/).
<p align="center">
<br>
<br>
<br>
<img align="center" src="https://github.com/cupcakearmy/autorestic/raw/master/.github/logo.png" height="50" alt="autorestic logo">
<br>
<br>
<p align="center">
Config driven, easy backup cli for <a href="https://restic.net/">restic</a>.
<br>
<strong><a href="https://autorestic.vercel.app/">»»» Docs & Getting Started »»»</a></strong>
<br><br>
<a target="_blank" href="https://discord.gg/wS7RpYTYd2">
<img src="https://img.shields.io/discord/252403122348097536" alt="discord badge" />
<img src="https://img.shields.io/github/contributors/cupcakearmy/autorestic" alt="contributor badge" />
<img src="https://img.shields.io/github/downloads/cupcakearmy/autorestic/total" alt="downloads badge" />
<img src="https://img.shields.io/github/v/release/cupcakearmy/autorestic" alt="version badge" />
</a>
</p>
</p>
Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficoult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
<br>
<br>
📒 **[DOCS](https://cupcakearmy.github.io/autorestic/)** 📒
### 💭 Why / What?
Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
### 🌈 Features
- YAML config files, no CLI
- Incremental -> Minimal space is used
- Backup locations to multiple backends
- Snapshot policies and pruning
- Fully encrypted
- Pre/After hooks
- Exclude pattern/files
- Cron jobs for automatic backup
- Backup & Restore docker volume
- Generated completions for `[bash|zsh|fish|powershell]`
### ❓ Questions / Support
Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions) or [join on discord](https://discord.gg/wS7RpYTYd2)
## Contributing / Developing
PRs, feature requests, etc. are welcomed :)
Have a look at [the dev docs](./DEVELOPMENT.md)

83
build/build.go Normal file
View File

@@ -0,0 +1,83 @@
// Heavily inspired (copied) by the restic build file
// https://github.com/restic/restic/blob/aa0faa8c7d7800b6ba7b11164fa2d3683f7f78aa/helpers/build-release-binaries/main.go#L225
package main
import (
"fmt"
"os"
"os/exec"
"path"
"path/filepath"
"sync"
"github.com/cupcakearmy/autorestic/internal"
)
var DIR, _ = filepath.Abs("./dist")
var targets = map[string][]string{
"darwin": {"amd64", "arm64"},
"freebsd": {"386", "amd64", "arm"},
"linux": {"386", "amd64", "arm", "arm64"},
"netbsd": {"386", "amd64"},
"openbsd": {"386", "amd64"},
}
type buildOptions struct {
Target, Arch, Version string
}
func build(options buildOptions, wg *sync.WaitGroup) {
fmt.Printf("Building %s %s\n", options.Target, options.Arch)
out := fmt.Sprintf("autorestic_%s_%s_%s", options.Version, options.Target, options.Arch)
out = path.Join(DIR, out)
out, _ = filepath.Abs(out)
fmt.Println(out)
// Build
{
c := exec.Command("go", "build", "-o", out, "./main.go")
c.Stdout = os.Stdout
c.Stderr = os.Stderr
c.Env = append(os.Environ(),
"CGO_ENABLED=0",
"GOOS="+options.Target,
"GOARCH="+options.Arch,
)
err := c.Run()
if err != nil {
panic(err)
}
}
// Compress
{
c := exec.Command("bzip2", out)
c.Dir = DIR
c.Stdout = os.Stdout
c.Stderr = os.Stderr
err := c.Run()
if err != nil {
panic(err)
}
}
wg.Done()
}
func main() {
os.RemoveAll(DIR)
v := internal.VERSION
var wg sync.WaitGroup
for target, archs := range targets {
for _, arch := range archs {
wg.Add(1)
build(buildOptions{
Target: target,
Arch: arch,
Version: v,
}, &wg)
}
}
wg.Wait()
}

42
cmd/backup.go Normal file
View File

@@ -0,0 +1,42 @@
package cmd
import (
"fmt"
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var backupCmd = &cobra.Command{
Use: "backup",
Short: "Create backups for given locations",
Run: func(cmd *cobra.Command, args []string) {
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
internal.GetConfig()
selected, err := internal.GetAllOrSelected(cmd, false)
CheckErr(err)
errors := 0
for _, name := range selected {
location, _ := internal.GetLocation(name)
errs := location.Backup(false)
for err := range errs {
colors.Error.Println(err)
errors++
}
}
if errors > 0 {
CheckErr(fmt.Errorf("%d errors were found", errors))
}
},
}
func init() {
rootCmd.AddCommand(backupCmd)
internal.AddFlagsToCommand(backupCmd, false)
}

26
cmd/check.go Normal file
View File

@@ -0,0 +1,26 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var checkCmd = &cobra.Command{
Use: "check",
Short: "Check if everything is setup",
Run: func(cmd *cobra.Command, args []string) {
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
CheckErr(internal.CheckConfig())
colors.Success.Println("Everything is fine.")
},
}
func init() {
rootCmd.AddCommand(checkCmd)
}

70
cmd/completion.go Normal file
View File

@@ -0,0 +1,70 @@
package cmd
import (
"os"
"github.com/spf13/cobra"
)
var completionCmd = &cobra.Command{
Use: "completion [bash|zsh|fish|powershell]",
Short: "Generate completion script",
Long: `To load completions:
Bash:
$ source <(autorestic completion bash)
# To load completions for each session, execute once:
# Linux:
$ autorestic completion bash > /etc/bash_completion.d/autorestic
# macOS:
$ autorestic completion bash > /usr/local/etc/bash_completion.d/autorestic
Zsh:
# If shell completion is not already enabled in your environment,
# you will need to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once:
$ autorestic completion zsh > "${fpath[1]}/_autorestic"
# You will need to start a new shell for this setup to take effect.
fish:
$ autorestic completion fish | source
# To load completions for each session, execute once:
$ autorestic completion fish > ~/.config/fish/completions/autorestic.fish
PowerShell:
PS> autorestic completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
PS> autorestic completion powershell > autorestic.ps1
# and source this file from your PowerShell profile.
`,
DisableFlagsInUseLine: true,
ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
Args: cobra.ExactValidArgs(1),
Run: func(cmd *cobra.Command, args []string) {
switch args[0] {
case "bash":
cmd.Root().GenBashCompletion(os.Stdout)
case "zsh":
cmd.Root().GenZshCompletion(os.Stdout)
case "fish":
cmd.Root().GenFishCompletion(os.Stdout, true)
case "powershell":
cmd.Root().GenPowerShellCompletionWithDesc(os.Stdout)
}
},
}
func init() {
rootCmd.AddCommand(completionCmd)
}

27
cmd/cron.go Normal file
View File

@@ -0,0 +1,27 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var cronCmd = &cobra.Command{
Use: "cron",
Short: "Run cron job for automated backups",
Long: `Intended to be mainly triggered by an automated system like systemd or crontab. For each location checks if a cron backup is due and runs it.`,
Run: func(cmd *cobra.Command, args []string) {
internal.CRON_LEAN, _ = cmd.Flags().GetBool("lean")
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
err = internal.RunCron()
CheckErr(err)
},
}
func init() {
rootCmd.AddCommand(cronCmd)
cronCmd.Flags().Bool("lean", false, "only output information about actual backups")
}

33
cmd/exec.go Normal file
View File

@@ -0,0 +1,33 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var execCmd = &cobra.Command{
Use: "exec",
Short: "Execute arbitrary native restic commands for given backends",
Run: func(cmd *cobra.Command, args []string) {
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
CheckErr(internal.CheckConfig())
selected, err := internal.GetAllOrSelected(cmd, true)
CheckErr(err)
for _, name := range selected {
colors.PrimaryPrint(" Executing on \"%s\" ", name)
backend, _ := internal.GetBackend(name)
backend.Exec(args)
}
},
}
func init() {
rootCmd.AddCommand(execCmd)
internal.AddFlagsToCommand(execCmd, true)
}

36
cmd/forget.go Normal file
View File

@@ -0,0 +1,36 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var forgetCmd = &cobra.Command{
Use: "forget",
Short: "Forget and optionally prune snapshots according the specified policies",
Run: func(cmd *cobra.Command, args []string) {
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
CheckErr(internal.CheckConfig())
selected, err := internal.GetAllOrSelected(cmd, false)
CheckErr(err)
prune, _ := cmd.Flags().GetBool("prune")
dry, _ := cmd.Flags().GetBool("dry-run")
for _, name := range selected {
location, _ := internal.GetLocation(name)
err := location.Forget(prune, dry)
CheckErr(err)
}
},
}
func init() {
rootCmd.AddCommand(forgetCmd)
internal.AddFlagsToCommand(forgetCmd, false)
forgetCmd.Flags().Bool("prune", false, "also prune repository")
forgetCmd.Flags().Bool("dry-run", false, "do not write changes, show what would be affected")
}

18
cmd/info.go Normal file
View File

@@ -0,0 +1,18 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal"
"github.com/spf13/cobra"
)
var infoCmd = &cobra.Command{
Use: "info",
Short: "Show info about the config",
Run: func(cmd *cobra.Command, args []string) {
internal.GetConfig().Describe()
},
}
func init() {
rootCmd.AddCommand(infoCmd)
}

19
cmd/install.go Normal file
View File

@@ -0,0 +1,19 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal/bins"
"github.com/spf13/cobra"
)
var installCmd = &cobra.Command{
Use: "install",
Short: "Install restic if missing",
Run: func(cmd *cobra.Command, args []string) {
err := bins.InstallRestic()
CheckErr(err)
},
}
func init() {
rootCmd.AddCommand(installCmd)
}

39
cmd/restore.go Normal file
View File

@@ -0,0 +1,39 @@
package cmd
import (
"fmt"
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
)
var restoreCmd = &cobra.Command{
Use: "restore",
Short: "Restore backup for location",
Run: func(cmd *cobra.Command, args []string) {
err := lock.Lock()
CheckErr(err)
defer lock.Unlock()
location, _ := cmd.Flags().GetString("location")
l, ok := internal.GetLocation(location)
if !ok {
CheckErr(fmt.Errorf("invalid location \"%s\"", location))
}
target, _ := cmd.Flags().GetString("to")
from, _ := cmd.Flags().GetString("from")
force, _ := cmd.Flags().GetBool("force")
err = l.Restore(target, from, force)
CheckErr(err)
},
}
func init() {
rootCmd.AddCommand(restoreCmd)
restoreCmd.Flags().BoolP("force", "f", false, "Force, target folder will be overwritten")
restoreCmd.Flags().String("from", "", "Which backend to use")
restoreCmd.Flags().String("to", "", "Where to restore the data")
restoreCmd.Flags().StringP("location", "l", "", "Location to be restored")
restoreCmd.MarkFlagRequired("location")
}

61
cmd/root.go Normal file
View File

@@ -0,0 +1,61 @@
package cmd
import (
"os"
"github.com/cupcakearmy/autorestic/internal"
"github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/spf13/cobra"
homedir "github.com/mitchellh/go-homedir"
"github.com/spf13/viper"
)
func CheckErr(err error) {
if err != nil {
colors.Error.Fprintln(os.Stderr, "Error:", err)
lock.Unlock()
os.Exit(1)
}
}
var cfgFile string
var rootCmd = &cobra.Command{
Version: internal.VERSION,
Use: "autorestic",
Short: "CLI Wrapper for restic",
Long: "Documentation: https://autorestic.vercel.app",
}
func Execute() {
CheckErr(rootCmd.Execute())
}
func init() {
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)")
rootCmd.PersistentFlags().BoolVar(&internal.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity")
rootCmd.PersistentFlags().BoolVarP(&internal.VERBOSE, "verbose", "v", false, "verbose mode")
rootCmd.PersistentFlags().StringVar(&internal.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
cobra.OnInitialize(initConfig)
}
func initConfig() {
if ci, _ := rootCmd.Flags().GetBool("ci"); ci {
colors.DisableColors(true)
internal.VERBOSE = true
}
if cfgFile != "" {
viper.SetConfigFile(cfgFile)
} else {
home, err := homedir.Dir()
CheckErr(err)
viper.AddConfigPath(".")
viper.AddConfigPath(home)
viper.SetConfigName(".autorestic")
}
viper.AutomaticEnv()
}

20
cmd/uninstall.go Normal file
View File

@@ -0,0 +1,20 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal/bins"
"github.com/spf13/cobra"
)
var uninstallCmd = &cobra.Command{
Use: "uninstall",
Short: "Uninstall restic and autorestic",
Run: func(cmd *cobra.Command, args []string) {
noRestic, _ := cmd.Flags().GetBool("no-restic")
bins.Uninstall(!noRestic)
},
}
func init() {
rootCmd.AddCommand(uninstallCmd)
uninstallCmd.Flags().Bool("no-restic", false, "do not uninstall restic.")
}

21
cmd/upgrade.go Normal file
View File

@@ -0,0 +1,21 @@
package cmd
import (
"github.com/cupcakearmy/autorestic/internal/bins"
"github.com/spf13/cobra"
)
var upgradeCmd = &cobra.Command{
Use: "upgrade",
Short: "Upgrade autorestic and restic",
Run: func(cmd *cobra.Command, args []string) {
noRestic, _ := cmd.Flags().GetBool("no-restic")
err := bins.Upgrade(!noRestic)
CheckErr(err)
},
}
func init() {
rootCmd.AddCommand(upgradeCmd)
upgradeCmd.Flags().Bool("no-restic", false, "also update restic")
}

15
docs/.codedoc/build.ts Normal file
View File

@@ -0,0 +1,15 @@
import { build } from '@codedoc/core';
import { config } from './config';
import { installTheme$ } from './content/theme';
import { content } from './content';
build(config, content, installTheme$, {
resolve: {
modules: ['.codedoc/node_modules']
},
resolveLoader: {
modules: ['.codedoc/node_modules']
}
});

24
docs/.codedoc/config.ts Normal file
View File

@@ -0,0 +1,24 @@
import { configuration } from '@codedoc/core'
export const config = configuration({
src: {
base: 'markdown',
},
dest: {
html: './build',
assets: './build',
bundle: './_',
styles: './_',
},
page: {
title: {
base: 'Autorestic',
},
},
misc: {
github: {
user: 'cupcakearmy',
repo: 'autorestic',
},
},
})

View File

@@ -0,0 +1,19 @@
import { CodedocConfig } from '@codedoc/core';
import { Footer as _Footer, GitterToggle$, Watermark} from '@codedoc/core/components';
export function Footer(config: CodedocConfig, renderer: any) {
let github$;
if (config.misc?.github)
github$ = <a href={`https://github.com/${config.misc.github.user}/${config.misc.github.repo}/`}
target="_blank">GitHub</a>;
let community$;
if (config.misc?.gitter)
community$ = <GitterToggle$ room={config.misc.gitter.room}/>
if (github$ && community$) return <_Footer>{github$}<hr/>{community$}</_Footer>;
else if (github$) return <_Footer>{github$}</_Footer>;
else if (community$) return <_Footer>{community$}</_Footer>;
else return <_Footer><Watermark/></_Footer>;
}

View File

@@ -0,0 +1,21 @@
import { CodedocConfig } from '@codedoc/core';
import { Header as _Header, GithubButton, Watermark } from '@codedoc/core/components';
export function Header(config: CodedocConfig, renderer: any) {
return (
<_Header>{config.misc?.github ?
<fragment>
<GithubButton action={config.misc.github.action || 'Star'}
repo={config.misc.github.repo}
user={config.misc.github.user}
large={config.misc.github.large === true}
count={config.misc.github.count !== false}
standardIcon={config.misc.github.standardIcon !== false}/>
<br/><br/>
</fragment>
: ''}
<Watermark/>
</_Header>
)
}

View File

@@ -0,0 +1,57 @@
import { RendererLike } from '@connectv/html'
import { File } from 'rxline/fs'
import {
Page,
Meta,
ContentNav,
Fonts,
ToC,
GithubSearch$,
} from '@codedoc/core/components'
import { config } from '../config'
import { Header } from './header'
import { Footer } from './footer'
export function content(
_content: HTMLElement,
toc: HTMLElement,
renderer: RendererLike<any, any>,
file: File<string>
) {
return (
<Page
title={config.page.title.extractor(_content, config, file)}
favicon={config.page.favicon}
meta={<Meta {...config.page.meta} />}
fonts={<Fonts {...config.page.fonts} />}
scripts={config.page.scripts}
stylesheets={config.page.stylesheets}
header={<Header {...config} />}
footer={<Footer {...config} />}
toc={
<ToC
default={'open'}
search={
config.misc?.github ? (
<GithubSearch$
repo={config.misc.github.repo}
user={config.misc.github.user}
root={config.src.base}
pick={config.src.pick.source}
drop={config.src.drop.source}
/>
) : (
false
)
}
>
{toc}
</ToC>
}
>
{_content}
<ContentNav content={_content} />
</Page>
)
}

View File

@@ -0,0 +1,8 @@
import { funcTransport } from '@connectv/sdh/transport';
import { useTheme } from '@codedoc/core/transport';
import { theme } from '../theme';
export function installTheme() { useTheme(theme); }
export const installTheme$ = /*#__PURE__*/funcTransport(installTheme);

10811
docs/.codedoc/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,5 @@
{
"dependencies": {
"@codedoc/core": "^0.2.23"
}
}

18
docs/.codedoc/serve.ts Normal file
View File

@@ -0,0 +1,18 @@
import { join } from 'path';
import { serve } from '@codedoc/core';
import { config } from './config';
import { content } from './content';
import { installTheme$ } from './content/theme';
const root = join(__dirname, '../');
serve(root, config, content, installTheme$, {
resolve: {
modules: ['.codedoc/node_modules']
},
resolveLoader: {
modules: ['.codedoc/node_modules']
}
});

11
docs/.codedoc/theme.ts Normal file
View File

@@ -0,0 +1,11 @@
import { createTheme } from '@codedoc/core/transport';
export const theme = /*#__PURE__*/createTheme({
light: {
primary: '#1eb2a6'
},
dark: {
primary: '#1eb2a6'
}
});

View File

@@ -0,0 +1,26 @@
{
"compilerOptions": {
"target": "es6",
"noImplicitAny": true,
"declaration": false,
"strictNullChecks": true,
"strictFunctionTypes": true,
"noImplicitThis": true,
"alwaysStrict": true,
"sourceMap": true,
"moduleResolution": "node",
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"jsx": "react",
"jsxFactory": "renderer.create",
"lib": [
"es2017",
"dom"
]
},
"include": [
"./**/*"
]
}

22
docs/.codedoc/watch.ts Normal file
View File

@@ -0,0 +1,22 @@
import { exec, spawn } from 'child_process';
import { config } from './config';
const cmd = 'ts-node-dev';
const params = `--project .codedoc/tsconfig.json`
+ ` -T --watch ${config.src.base},.codedoc`
+ ` --ignore-watch .codedoc/node_modules`
+ ` .codedoc/serve`;
if (process.platform === 'win32') {
const child = exec(cmd + ' ' + params);
child.stdout?.pipe(process.stdout);
child.stderr?.pipe(process.stderr);
child.on('close', () => {});
}
else {
const child = spawn(cmd, [params], { stdio: 'inherit', shell: 'bash' });
child.on('close', () => {});
}

2
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
node_modules
build

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Backends</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="backends" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Backends</h1><div class="contentnav-0-0-14" data-no-search=""><a href="#backends" class="h1" data-content-highlight="backends">Backends</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="GNSXnlBhXj">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("GNSXnlBhXj", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="IalauPyNzn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("IalauPyNzn", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="oJrBRLjhOg">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("oJrBRLjhOg", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="cZ_oLXMNNy">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("cZ_oLXMNNy", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="cvnSMiFXuL">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("cvnSMiFXuL", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="FlgRfeyFrY">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("FlgRfeyFrY", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="wMLYXDNWjo">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("wMLYXDNWjo", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Cron</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="cron" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Cron</h1><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic cron"><span class="lineCounter-0-0-4 prim">1</span>autorestic <span class="token function">cron</span></div><br></code></pre><p>This command is modtly intended to be triggered by an automated system like systemd or crontab.</p><p>It will run cron jobs es <a href="/autorestic/locations/cron">specified in the cron section</a> of a specific location.</p><script id="O_aOdEQuYg">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("O_aOdEQuYg", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#cron" class="h1" data-content-highlight="cron">Cron</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="fcilFUHmkO">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("fcilFUHmkO", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="CnnbQMdrpE">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("CnnbQMdrpE", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="FbPHSDLXcR">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("FbPHSDLXcR", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="isfvbRMpGA">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("isfvbRMpGA", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="TtdtfcifZq">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("TtdtfcifZq", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="QRI_LiMpkt">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("QRI_LiMpkt", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="reFMhIwCOr">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("reFMhIwCOr", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1,57 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | info</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="info" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>info</h1><p>Displays the config file that autorestic is refering to.
Usefull when you want to quickly see what locations are being backuped where.</p><p><strong>Pro tip:</strong> if it gets a bit long you can read it more easily with <code>autorestic info | less</code> 😉</p><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic info"><span class="lineCounter-0-0-4 prim">1</span>autorestic info</div><br></code></pre><h2 id="with-a-custom-file" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>With a custom file</h2><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic -c path/to/some/config.yml info"><span class="lineCounter-0-0-4 prim">1</span>autorestic -c path/to/some/config.yml info</div><br></code></pre><script id="GyQprlRakI">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("GyQprlRakI", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#info" class="h1" data-content-highlight="info">info</a><a href="#with-a-custom-file" class="h2" data-content-highlight="with-a-custom-file">With a custom file</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="THkEpAqvtI">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("THkEpAqvtI", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="zGicgWIC_t">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("zGicgWIC_t", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="oPguniuEYv">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("oPguniuEYv", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="BUCBIEDpuS">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("BUCBIEDpuS", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="wJNSKGVSXH">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("wJNSKGVSXH", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="tMcddMGaNJ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("tMcddMGaNJ", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="czotsScjjc">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("czotsScjjc", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Install</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/docs/assets/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/docs/assets/codedoc-bundle.js"></script></head><body><div class="header-0-0-5"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-4" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="install" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Install</h1><p>Installs both restic and autorestic to <code>/usr/local/bin</code>.</p><pre class=""><code class="bash code-0-0-11" tabindex="0"><span class="wmbar-0-0-14"><span></span><span></span><span></span><span></span></span><div class="line-0-0-13 " data-content="autorestic install"><span class="lineCounter-0-0-12 prim">1</span>autorestic <span class="token function">install</span></div><br></code></pre><div class="contentnav-0-0-10" data-no-search=""><a href="#install" class="h1" data-content-highlight="install">Install</a></div></div><div id="-codedoc-toc" class="toc-0-0-7"><div class="content-0-0-8"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-3 "><script id="XRGCUvVncP">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("XRGCUvVncP", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/locations/overview">Overview</a>
<a href="/autorestic/locations/types">Types</a>
<a href="/autorestic/locations/cron">Cron</a>
<a href="/autorestic/locations/hooks">Hooks</a>
<a href="/autorestic/locations/exclude">Exclude</a>
<a href="/autorestic/locations/forget">Forget Policy</a>
<a href="/autorestic/locations/advanced">Advanced Options</a></p></div></div><div class="collapse-0-0-3 "><script id="friLMtMuGC">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("friLMtMuGC", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-3 "><script id="anTYnIWqbu">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("anTYnIWqbu", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-9"><script id="jzgqiz_Esn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("jzgqiz_Esn", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-6"><div class="left"><script id="asTmHrhSzG">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("asTmHrhSzG", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="LyCwkXYPUl">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("LyCwkXYPUl", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="mhGgCSJbMB">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("mhGgCSJbMB", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Install</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="install" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Install</h1><p>Installs both restic and autorestic to <code>/usr/local/bin</code>.</p><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic install"><span class="lineCounter-0-0-4 prim">1</span>autorestic <span class="token function">install</span></div><br></code></pre><script id="JxghuHZGdc">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("JxghuHZGdc", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#install" class="h1" data-content-highlight="install">Install</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="su_ZjdszSj">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("su_ZjdszSj", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="UdtQri_cEx">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("UdtQri_cEx", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="dopRimicAn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("dopRimicAn", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="ZkNdsnJYsZ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("ZkNdsnJYsZ", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="aKYAuTsQzZ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("aKYAuTsQzZ", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="zM_iKmUebH">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("zM_iKmUebH", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="eLCMkXzjoj">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("eLCMkXzjoj", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

File diff suppressed because one or more lines are too long

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Uninstall</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="uninstall" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Uninstall</h1><p>Installs both restic and autorestic from <code>/usr/local/bin</code>.</p><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic uninstall"><span class="lineCounter-0-0-4 prim">1</span>autorestic uninstall</div><br></code></pre><script id="LxFGjAGVBx">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("LxFGjAGVBx", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#uninstall" class="h1" data-content-highlight="uninstall">Uninstall</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="HaMjtZoxUL">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("HaMjtZoxUL", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="xUBRW_EMLd">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("xUBRW_EMLd", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="tYYbzxROpQ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("tYYbzxROpQ", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="wIReKlOBOo">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("wIReKlOBOo", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="GeMKjbAicN">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("GeMKjbAicN", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="CtXUhFwJLZ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("CtXUhFwJLZ", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="DcbchwJqbR">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DcbchwJqbR", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | Update</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="update" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>Update</h1><p>Autorestic can update itself! Super handy right? Simply run autorestic update and we will check for you if there are updates for restic and autorestic and install them if necessary.</p><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="autorestic update"><span class="lineCounter-0-0-4 prim">1</span>autorestic update</div><br></code></pre><p>Updates both restic and autorestic automagically.</p><script id="ZzUFOtdnlJ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("ZzUFOtdnlJ", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#update" class="h1" data-content-highlight="update">Update</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="VlfyQcEBCm">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("VlfyQcEBCm", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="XQJbkSKNAO">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("XQJbkSKNAO", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="HISjWmhnkn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("HISjWmhnkn", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="oiIRgRmVXQ">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("oiIRgRmVXQ", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="todGaBBrdS">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("todGaBBrdS", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="DInTUdmcuq">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DInTUdmcuq", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="a_gXDtclPw">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("a_gXDtclPw", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

File diff suppressed because one or more lines are too long

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | 🙋‍♀️🙋‍♂️ Contributors</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="🙋♀️🙋♂️-contributors" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>🙋‍♀️🙋‍♂️ Contributors</h1><p>This amazing people helped the project!</p><ul><li>@ChanceM [Docs]</li><li>@EliotBerriot [Docs, Pruning, S3]</li></ul><script id="pPGHMLfBL_">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("pPGHMLfBL_", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#🙋♀️🙋♂️-contributors" class="h1" data-content-highlight="🙋♀️🙋♂️-contributors">🙋‍♀️🙋‍♂️ Contributors</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="fPmwVDeSEj">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("fPmwVDeSEj", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="DplZYNoQGK">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DplZYNoQGK", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="DgyXyKVnwl">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DgyXyKVnwl", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="DXrTuFFVsh">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DXrTuFFVsh", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="bLmHZwaNgB">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("bLmHZwaNgB", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="mXwqejsEnV">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("mXwqejsEnV", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="IZCIDSmAHy">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("IZCIDSmAHy", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -1,40 +0,0 @@
import { getRenderer } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/renderer.js';
import { initJssCs } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/setup-jss.js';initJssCs();
import { installTheme } from '/Users/nicco/Documents/git/autorestic/.codedoc/content/theme.ts';installTheme();
import { codeSelection } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/selection.js';codeSelection();
import { sameLineLengthInCodes } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/same-line-length.js';sameLineLengthInCodes();
import { initHintBox } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/line-hint/index.js';initHintBox();
import { initCodeLineRef } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/line-ref/index.js';initCodeLineRef();
import { initSmartCopy } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/smart-copy.js';initSmartCopy();
import { copyHeadings } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/heading/copy-headings.js';copyHeadings();
import { contentNavHighlight } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/contentnav/highlight.js';contentNavHighlight();
import { loadDeferredIFrames } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/deferred-iframe.js';loadDeferredIFrames();
import { smoothLoading } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/smooth-loading.js';smoothLoading();
import { tocHighlight } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/toc-highlight.js';tocHighlight();
import { postNavSearch } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/search/post-nav/index.js';postNavSearch();
import { ToCPrevNext } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/prevnext/index.js';
import { CollapseControl } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/collapse/collapse-control.js';
import { GithubSearch } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/misc/github/search.js';
import { ToCToggle } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/toggle/index.js';
import { DarkModeSwitch } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/darkmode/index.js';
import { ConfigTransport } from '/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/config.js';
const components = {
'qcaKEY878Mn2dFQW/lSrDg==': ToCPrevNext,
'fz894w7KG2/tX4kLbbA1Kg==': CollapseControl,
'+SrlfVhZ/PRQ5WhUlZbTaA==': GithubSearch,
'XsNW3ht5ee+RmVUActEo9g==': ToCToggle,
'Y1WWvCKxkgk1yh8xbCfXqw==': DarkModeSwitch,
'v641FmLj+AeGp0uuFTI6ug==': ConfigTransport
};
const renderer = getRenderer();
const ogtransport = window.__sdh_transport;
window.__sdh_transport = function(id, hash, props) {
if (hash in components) {
const target = document.getElementById(id);
renderer.render(renderer.create(components[hash], props)).after(target);
target.remove();
}
else if (ogtransport) ogtransport(id, hash, props);
}

File diff suppressed because one or more lines are too long

View File

@@ -1,106 +0,0 @@
{
"init": [
{
"name": "initJssCs",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/setup-jss.js",
"hash": "c/OJpUDX26Qm4IbMYtLbjg=="
},
{
"name": "installTheme",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/content/theme.ts",
"hash": "obU6UstdkSAvgbysOh3/eg=="
},
{
"name": "codeSelection",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/selection.js",
"hash": "4VXGhMNJRz8Eyjdvm6ntYg=="
},
{
"name": "sameLineLengthInCodes",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/same-line-length.js",
"hash": "nEpV43sODVDt+zjIO7H9+A=="
},
{
"name": "initHintBox",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/line-hint/index.js",
"hash": "9M6+/niHbbHMYKbOF0DTzg=="
},
{
"name": "initCodeLineRef",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/line-ref/index.js",
"hash": "rPwNL8eX+bbHwAgvTQ8Iag=="
},
{
"name": "initSmartCopy",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/code/smart-copy.js",
"hash": "xFnLgdNzBUv9BdaGDgvJDA=="
},
{
"name": "copyHeadings",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/heading/copy-headings.js",
"hash": "i1yTTWSH2AaFOCy2yKgs0Q=="
},
{
"name": "contentNavHighlight",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/contentnav/highlight.js",
"hash": "SpIa+6Gg/KMV7Wb4QvBzcg=="
},
{
"name": "loadDeferredIFrames",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/deferred-iframe.js",
"hash": "naHAbpxvOw4i/sUpn2LnRQ=="
},
{
"name": "smoothLoading",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/smooth-loading.js",
"hash": "vXAT5HUat2IZoc8ZEN/OKA=="
},
{
"name": "tocHighlight",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/toc-highlight.js",
"hash": "suB+mCUXKx/0sad/yURMug=="
},
{
"name": "postNavSearch",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/search/post-nav/index.js",
"hash": "/izvKWQZGCWZbwwWyiivfw=="
}
],
"components": [
{
"name": "ToCPrevNext",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/prevnext/index.js",
"hash": "qcaKEY878Mn2dFQW/lSrDg=="
},
{
"name": "CollapseControl",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/collapse/collapse-control.js",
"hash": "fz894w7KG2/tX4kLbbA1Kg=="
},
{
"name": "GithubSearch",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/misc/github/search.js",
"hash": "+SrlfVhZ/PRQ5WhUlZbTaA=="
},
{
"name": "ToCToggle",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/page/toc/toggle/index.js",
"hash": "XsNW3ht5ee+RmVUActEo9g=="
},
{
"name": "DarkModeSwitch",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/components/darkmode/index.js",
"hash": "Y1WWvCKxkgk1yh8xbCfXqw=="
},
{
"name": "ConfigTransport",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/config.js",
"hash": "v641FmLj+AeGp0uuFTI6ug=="
}
],
"renderer": {
"name": "getRenderer",
"filename": "/Users/nicco/Documents/git/autorestic/.codedoc/node_modules/@codedoc/core/dist/es6/transport/renderer.js",
"hash": "DuikI/Y5reNcodaSzsxs0w=="
}
}

View File

@@ -1,871 +0,0 @@
.heading-0-0-1 {
cursor: pointer;
position: relative;
}
.anchor-0-0-2 {
top: 0;
left: -32px;
bottom: 0;
display: flex;
opacity: 0;
position: absolute;
transform: translateX(-8px);
transition: opacity .1s, transform .1s;
align-items: center;
padding-right: 8px;
}
.heading-0-0-1:hover .anchor-0-0-2 {
opacity: 0.5;
transform: none;
}
.heading-0-0-1:hover .anchor-0-0-2:hover {
opacity: 1;
}
.code-0-0-3 {
color: #e0e0e0;
display: block;
outline: none;
padding: 24px 0;
position: relative;
font-size: 13px;
background: #212121;
box-shadow: 0 6px 12px rgba(0, 0, 0, .25);
overflow-x: auto;
user-select: none;
border-radius: 3px;
-webkit-user-select: none;
}
pre.with-bar .code-0-0-3 {
padding-top: 0;
}
.code-0-0-3 .token.keyword {
color: #7187ff;
}
.code-0-0-3 .token.string {
color: #69f0ae;
}
.code-0-0-3 .token.number {
color: #ffc400;
}
.code-0-0-3 .token.boolean {
color: #ffc400;
}
.code-0-0-3 .token.operator {
color: #18ffff;
}
.code-0-0-3 .token.function {
color: #e0e0e0;
}
.code-0-0-3 .token.parameter {
color: #e0e0e0;
}
.code-0-0-3 .token.comment {
color: #757575;
}
.code-0-0-3 .token.tag {
color: #ffa372;
}
.code-0-0-3 .token.builtin {
color: #e0e0e0;
}
.code-0-0-3 .token.punctuation {
color: #fcf7bb;
}
.code-0-0-3 .token.class-name {
color: #e0e0e0;
}
.code-0-0-3 .token.attr-name {
color: #f6d186;
}
.code-0-0-3 .token.attr-value {
color: #69f0ae;
}
.code-0-0-3 .token.plain-text {
color: #bdbdbd;
}
.code-0-0-3 .token.script {
color: #e0e0e0;
}
.code-0-0-3 .token.placeholder {
color: #18ffff;
}
.code-0-0-3 .token.selector {
color: #ffa372;
}
.code-0-0-3 .token.property {
color: #f6d186;
}
.code-0-0-3 .token.important {
color: #be79df;
}
.code-0-0-3.scss .token.function, .code-0-0-3.css .token.function, .code-0-0-3.sass .token.function {
color: #9aceff;
}
.code-0-0-3 .token.key {
color: #f6d186;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .code-0-0-3 {
color: #e0e0e0;
background: #000000;
box-shadow: 0 6px 12px #121212;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.keyword {
color: #7187ff;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.string {
color: #69f0ae;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.number {
color: #ffc400;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.boolean {
color: #ffc400;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.operator {
color: #18ffff;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.function {
color: #e0e0e0;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.parameter {
color: #e0e0e0;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.comment {
color: #757575;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.tag {
color: #ffa372;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.builtin {
color: #e0e0e0;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.punctuation {
color: #fcf7bb;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.class-name {
color: #e0e0e0;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.attr-name {
color: #f6d186;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.attr-value {
color: #69f0ae;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.plain-text {
color: #bdbdbd;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.script {
color: #e0e0e0;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.placeholder {
color: #18ffff;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.selector {
color: #ffa372;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.property {
color: #f6d186;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.important {
color: #be79df;
}
body:not(.dark-mode-animate) .code-0-0-3.scss .token.function, body:not(.dark-mode-animate) .code-0-0-3.css .token.function, body:not(.dark-mode-animate) .code-0-0-3.sass .token.function {
color: #9aceff;
}
body:not(.dark-mode-animate) .code-0-0-3 .token.key {
color: #f6d186;
}
}
body.dark .code-0-0-3 {
color: #e0e0e0;
background: #000000;
box-shadow: 0 6px 12px #121212;
}
body.dark .code-0-0-3 .token.keyword {
color: #7187ff;
}
body.dark .code-0-0-3 .token.string {
color: #69f0ae;
}
body.dark .code-0-0-3 .token.number {
color: #ffc400;
}
body.dark .code-0-0-3 .token.boolean {
color: #ffc400;
}
body.dark .code-0-0-3 .token.operator {
color: #18ffff;
}
body.dark .code-0-0-3 .token.function {
color: #e0e0e0;
}
body.dark .code-0-0-3 .token.parameter {
color: #e0e0e0;
}
body.dark .code-0-0-3 .token.comment {
color: #757575;
}
body.dark .code-0-0-3 .token.tag {
color: #ffa372;
}
body.dark .code-0-0-3 .token.builtin {
color: #e0e0e0;
}
body.dark .code-0-0-3 .token.punctuation {
color: #fcf7bb;
}
body.dark .code-0-0-3 .token.class-name {
color: #e0e0e0;
}
body.dark .code-0-0-3 .token.attr-name {
color: #f6d186;
}
body.dark .code-0-0-3 .token.attr-value {
color: #69f0ae;
}
body.dark .code-0-0-3 .token.plain-text {
color: #bdbdbd;
}
body.dark .code-0-0-3 .token.script {
color: #e0e0e0;
}
body.dark .code-0-0-3 .token.placeholder {
color: #18ffff;
}
body.dark .code-0-0-3 .token.selector {
color: #ffa372;
}
body.dark .code-0-0-3 .token.property {
color: #f6d186;
}
body.dark .code-0-0-3 .token.important {
color: #be79df;
}
body.dark .code-0-0-3.scss .token.function, body.dark .code-0-0-3.css .token.function, body.dark .code-0-0-3.sass .token.function {
color: #9aceff;
}
body.dark .code-0-0-3 .token.key {
color: #f6d186;
}
.lineCounter-0-0-4 {
left: 0;
color: transparent;
width: 24px;
height: 1.25rem;
display: inline-flex;
position: sticky;
font-size: 10px;
background: #212121;
align-items: center;
border-right: 2px solid rgba(255, 255, 255, .015);
margin-right: 12px;
padding-right: 12px;
flex-direction: row-reverse;
vertical-align: top;
}
.lineCounter-0-0-4.prim {
color: #616161;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .lineCounter-0-0-4 {
background: #000000;
border-color: rgba(255, 255, 255, .015);
}
body:not(.dark-mode-animate) .lineCounter-0-0-4.prim {
color: #616161;
}
}
body.dark .lineCounter-0-0-4 {
background: #000000;
border-color: rgba(255, 255, 255, .015);
}
body.dark .lineCounter-0-0-4.prim {
color: #616161;
}
.line-0-0-5 {
cursor: pointer;
height: 1.25rem;
display: inline-block;
min-width: 100%;
background: transparent;
transition: opacity .15s;
}
.has-selection .line-0-0-5:not(.selected) {
opacity: 0.35;
transition: opacity 3s;
}
.line-0-0-5.highlight {
color: #ffffff;
background: rgb(40, 46, 73);
}
.line-0-0-5.selected .lineCounter-0-0-4 {
border-color: #7187ff !important;
}
.line-0-0-5:hover, .line-0-0-5.selected {
background: #3b3b3b;
}
.line-0-0-5:hover .lineCounter-0-0-4 {
border-color: rgba(255, 255, 255, .1);
}
body.dark .line-0-0-5:hover .lineCounter-0-0-4 {
border-color: rgba(255, 255, 255, .1);
}
.line-0-0-5:hover .lineCounter-0-0-4, .line-0-0-5.selected .lineCounter-0-0-4 {
color: #7187ff;
background: #3b3b3b !important;
}
body.dark .line-0-0-5:hover, body.dark .line-0-0-5.selected {
background: #1a1a1a !important;
}
body.dark .line-0-0-5:hover .lineCounter-0-0-4, body.dark .line-0-0-5.selected .lineCounter-0-0-4 {
color: #7187ff;
background: #1a1a1a !important;
}
body.dark .line-0-0-5.selected .lineCounter-0-0-4 {
border-color: #7187ff !important;
}
.line-0-0-5.highlight .lineCounter-0-0-4 {
background: rgb(40, 46, 73);
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .line-0-0-5.highlight {
color: #ffffff;
background: rgb(28, 29, 48);
}
body:not(.dark-mode-animate) .line-0-0-5.highlight .lineCounter-0-0-4 {
background: rgb(28, 29, 48);
}
}
body.dark .line-0-0-5.highlight {
color: #ffffff;
background: rgb(28, 29, 48);
}
body.dark .line-0-0-5.highlight .lineCounter-0-0-4 {
background: rgb(28, 29, 48);
}
.wmbar-0-0-6 {
left: 0;
display: none;
padding: 16px;
position: sticky;
}
.wmbar-0-0-6>span {
display: block;
opacity: 0.5;
flex-grow: 1;
font-size: 12px;
text-align: center;
font-family: sans-serif;
margin-right: 64px;
}
.wmbar-0-0-6>span:first-child, .wmbar-0-0-6>span:nth-child(2), .wmbar-0-0-6>span:nth-child(3) {
width: 8px;
height: 8px;
opacity: 1;
flex-grow: 0;
margin-right: 8px;
border-radius: 8px;
}
pre.with-bar .wmbar-0-0-6 {
display: flex;
}
.wmbar-0-0-6>span:first-child:first-child, .wmbar-0-0-6>span:nth-child(2):first-child, .wmbar-0-0-6>span:nth-child(3):first-child {
background: rgb(255, 95, 86);
}
.wmbar-0-0-6>span:first-child:nth-child(2), .wmbar-0-0-6>span:nth-child(2):nth-child(2), .wmbar-0-0-6>span:nth-child(3):nth-child(2) {
background: rgb(255, 189, 46);
}
.wmbar-0-0-6>span:first-child:nth-child(3), .wmbar-0-0-6>span:nth-child(2):nth-child(3), .wmbar-0-0-6>span:nth-child(3):nth-child(3) {
background: rgb(39, 201, 63);
}
.collapse-0-0-7>.label {
cursor: pointer;
margin: 8px 0;
display: flex;
align-items: center;
user-select: none;
}
.collapse-0-0-7>.content {
opacity: 0;
max-height: 0;
transition: opacity .3s;
visibility: hidden;
border-left: 2px solid rgba(224, 224, 224, 0.5);
padding-left: 16px;
}
.collapse-0-0-7.open>.content {
opacity: 1;
max-height: none;
visibility: visible;
}
.collapse-0-0-7.open>.label .icon-font {
transform: rotate(90deg);
}
body.dark-mode-animate .collapse-0-0-7>.content {
transition: transform .15s, opacity .15s, border-color .3s;
}
body.dark .collapse-0-0-7>.content {
border-color: rgba(49, 49, 49, 0.5);
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .collapse-0-0-7>.content {
border-color: rgba(49, 49, 49, 0.5);
}
}
.collapse-0-0-7>.label .text {
flex-grow: 1;
}
.collapse-0-0-7>.label .icon-font {
margin-right: 32px;
}
.collapse-0-0-7>.label:hover {
color: #1eb2a6;
transition: color .15s;
}
body.dark .collapse-0-0-7>.label:hover {
color: #1eb2a6;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .collapse-0-0-7>.label:hover {
color: #1eb2a6;
}
}
body.dark-mode-animate .collapse-0-0-7>.label .icon-font {
transition: transform .15s;
}
.watermark-0-0-8 {
color: #424242;
cursor: pointer;
display: inline-block;
opacity: 0.2;
font-size: 8px;
transition: opacity .15s;
text-decoration: none !important;
}
body.dark-mode-animate .watermark-0-0-8 {
transition: opacity .15s, color .3s;
}
.watermark-0-0-8:hover {
opacity: 1;
text-decoration: none;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .watermark-0-0-8 {
color: #eeeeee;
}
}
body.dark .watermark-0-0-8 {
color: #eeeeee;
}
.watermark-0-0-8 svg {
width: 2.8rem;
display: block;
margin-top: .25rem;
}
.watermark-0-0-8 svg g {
fill: #424242;
}
body.dark-mode-animate .watermark-0-0-8 svg g {
transition: fill .3s;
}
body.dark .watermark-0-0-8 svg g {
fill: #eeeeee;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .watermark-0-0-8 svg g {
fill: #eeeeee;
}
}
.header-0-0-9 {
top: 0;
right: 0;
padding: 32px;
z-index: 100;
position: fixed;
text-align: right;
}
.footer-0-0-10 {
left: 0;
right: 0;
bottom: 0;
height: 64px;
display: flex;
z-index: 102;
position: fixed;
background: rgba(245, 245, 245, 0.85);
box-shadow: 0 -2px 6px rgba(0, 0, 0, .03);
align-items: center;
backdrop-filter: blur(12px);
justify-content: center;
-webkit-backdrop-filter: blur(12px);
}
body.dark-mode-animate .footer-0-0-10 {
transition: background .3s;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .footer-0-0-10 {
background: rgba(33, 33, 33, 0.85);
}
}
body.dark .footer-0-0-10 {
background: rgba(33, 33, 33, 0.85);
}
.footer-0-0-10 .main {
overflow: hidden;
flex-grow: 1;
text-align: center;
}
.footer-0-0-10 .left {
padding-left: 32px;
}
.footer-0-0-10 .right {
padding-right: 32px;
}
@media screen and (max-width: 800px) {
.footer-0-0-10 .left {
padding-left: 16px;
}
.footer-0-0-10 .right {
padding-right: 16px;
}
}
.footer-0-0-10 .main>.inside {
display: inline-flex;
overflow: auto;
max-width: 100%;
align-items: center;
}
.footer-0-0-10 .main>.inside hr {
width: 2px;
border: none;
height: 16px;
margin: 16px;
background: #e0e0e0;
}
.footer-0-0-10 .main>.inside a {
text-decoration: none;
}
.footer-0-0-10 .main>.inside a:hover {
text-decoration: underline ;
}
body.dark-mode-animate .footer-0-0-10 .main>.inside hr {
transition: background .3s;
}
body.dark .footer-0-0-10 .main>.inside hr {
background: #313131;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .footer-0-0-10 .main>.inside hr {
background: #313131;
}
}
.toc-0-0-11 {
top: 0;
left: 0;
width: calc(50vw - 464px);
bottom: 0;
display: flex;
z-index: 101;
position: fixed;
transform: translateX(-50vw);
background: #f1f1f1;
border-right: 1px solid #e7e7e7;
flex-direction: column;
padding-bottom: 64px;
}
body.dark-mode-animate .toc-0-0-11 {
transition: background .3s, border-color .3s;
}
body.dark .toc-0-0-11 {
background: #1f1f1f;
border-color: #282828;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .toc-0-0-11 {
background: #1f1f1f;
border-color: #282828;
}
}
@media screen and (max-width: 1200px) {
.toc-0-0-11 {
width: 100vw;
transform: translateX(-110vw);
}
}
.toc-0-0-11.animated {
transition: transform .3s;
}
.toc-0-0-11.active {
transform: translateX(0);
}
.toc-0-0-11 p {
margin: 0;
}
.toc-0-0-11 a {
border: 1px solid transparent;
display: block;
padding: 8px;
margin-left: -8px;
border-right: none;
margin-right: 1px;
border-radius: 3px;
text-decoration: none;
}
body.dark-mode-animate .toc-0-0-11 a {
transition: border-color .3s, background .3s;
}
.toc-0-0-11 a:hover {
background: #f5f5f5;
text-decoration: none;
}
.toc-0-0-11 a.current {
background: #f5f5f5;
border-color: #e7e7e7;
margin-right: 0;
border-top-right-radius: 0;
border-bottom-right-radius: 0;
}
body.dark .toc-0-0-11 a.current {
background: hsl(0, 0%, 13.2%);
border-color: #282828;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .toc-0-0-11 a.current {
background: #212121;
border-color: #282828;
}
}
@media screen and (max-width: 1200px) {
.toc-0-0-11 a.current {
border-right: 1px solid;
margin-right: -8px;
border-radius: 3px;
}
}
body.dark .toc-0-0-11 a:hover {
background: hsl(0, 0%, 13.2%);
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .toc-0-0-11 a:hover {
background: hsl(0, 0%, 13.2%);
}
}
body.dark-mode-animate .toc-0-0-11.animated {
transition: transform .3s, background .3s, border-color .3s;
}
.content-0-0-12 {
padding: 32px;
overflow: auto;
flex-grow: 1;
margin-right: -1px;
padding-right: 0;
}
@media screen and (max-width: 1200px) {
.content-0-0-12 {
margin-right: 0;
padding-right: 32px;
}
}
.contentnav-0-0-14 {
right: 0;
width: calc(50vw - 496px);
bottom: 96px;
position: fixed;
font-size: 12px;
border-left: 1px dashed #e0e0e0;
margin-left: 64px;
padding-left: 48px;
}
@media screen and (max-width: 1200px) {
.contentnav-0-0-14 {
display: none;
}
}
.contentnav-0-0-14 a {
color: #424242;
display: block;
opacity: 0.2;
text-decoration: none;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) .contentnav-0-0-14 {
border-color: #313131;
}
body:not(.dark-mode-animate) .contentnav-0-0-14 a {
color: #eeeeee;
}
body:not(.dark-mode-animate) .contentnav-0-0-14 a:hover, body:not(.dark-mode-animate) .contentnav-0-0-14 a.active {
color: #1eb2a6;
}
}
body.dark .contentnav-0-0-14 {
border-color: #313131;
}
body.dark .contentnav-0-0-14 a {
color: #eeeeee;
}
body.dark .contentnav-0-0-14 a:hover, body.dark .contentnav-0-0-14 a.active {
color: #1eb2a6;
}
body.dark-mode-animate .contentnav-0-0-14 a {
transition: color .3s, opacity .3s;
}
.contentnav-0-0-14 a:hover, .contentnav-0-0-14 a.active {
color: #1eb2a6;
opacity: 1;
}
.contentnav-0-0-14 a.h2 {
margin-left: 12px;
}
.contentnav-0-0-14 a.h3 {
margin-left: 24px;
}
.contentnav-0-0-14 a.h4 {
margin-left: 36px;
}
.contentnav-0-0-14 a.h5 {
margin-left: 48px;
}
.contentnav-0-0-14 a.h6 {
margin-left: 60px;
}
* {
touch-action: manipulation;
scroll-behavior: smooth;
-webkit-tap-highlight-color: transparent;
}
body {
color: #424242;
width: 100vw;
margin: 0;
padding: 0;
background: #f5f5f5;
overflow-x: hidden;
backface-visibility: hidden;
-webkit-backface-visibility: hidden;
}
body.dark-mode-animate {
transition: color .3s, background .3s;
}
a {
color: #1eb2a6;
}
a:hover {
text-decoration: underline;
text-decoration-thickness: 2px;
}
body.dark-mode-animate a {
transition: color .3s;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) a {
color: #1eb2a6;
}
}
body.dark a {
color: #1eb2a6;
}
.container {
margin: 0 auto;
padding: 96px 16px;
max-width: 768px;
transition: opacity .15s;
}
hr {
border: none;
margin: 64px;
background: none;
border-top: 1px solid #e0e0e0;
}
body.dark-mode-animate hr {
transition: border-color .3s;
}
body.dark hr {
border-color: #313131;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) hr {
border-color: #313131;
}
}
blockquote {
color: #757575;
margin: 0;
padding: 16px 40px;
position: relative;
background: #eeeeee;
border-radius: 3px;
}
body.dark-mode-animate blockquote {
transition: color .3s, background .3s;
}
blockquote:after {
top: 16px;
left: 16px;
width: 8px;
bottom: 16px;
content: '';
display: block;
position: absolute;
background: radial-gradient(circle at center, #e0e0e0 50%, transparent 52%),transparent;
background-size: 4px 4px;
}
body.dark-mode-animate blockquote:after {
transition: color .3s, background .3s;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) {
color: #eeeeee;
background: #212121;
}
body:not(.dark-mode-animate) blockquote {
color: #cacaca;
background: #282828;
}
body:not(.dark-mode-animate) blockquote:after {
background: radial-gradient(circle at center, #363636 50%, transparent 52%),transparent;
background-size: 4px 4px;
}
}
body.dark {
color: #eeeeee;
background: #212121;
}
body.dark blockquote {
color: #cacaca;
background: #282828;
}
body.dark blockquote:after {
background: radial-gradient(circle at center, #363636 50%, transparent 52%),transparent;
background-size: 4px 4px;
}
img {
max-width: 100%;
}
iframe {
width: 100%;
border: none;
background: white;
border-radius: 3px;
}
code {
color: #616161;
padding: 4px;
font-size: .85em;
background: #eeeeee;
border-radius: 3px;
}
body.dark-mode-animate code {
transition: color .3s, background .3s;
}
body.dark code {
color: #e0e0e0;
background: #282828;
}
@media (prefers-color-scheme: dark) {
body:not(.dark-mode-animate) code {
color: #e0e0e0;
background: #282828;
}
}

File diff suppressed because one or more lines are too long

View File

@@ -1,58 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | autorestic</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="autorestic" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>autorestic</h1><p>High backup level CLI utility for <a href="https://restic.net/">restic</a>.</p><p>Autorestic is a wrapper around the amazing <a href="https://restic.net/">restic</a>. While being amazing the restic cli can be a bit overwhelming and difficoult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂</p><marker><!-- ![Sketch](./docs/Sketch.png) -->
</marker><h2 id="✈️-roadmap" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>✈️ Roadmap</h2><p>I would like to make the official <code>1.0</code> release in the coming months. Until then please feel free to file issues or feature requests so that the tool is as flexible as possible :)</p><h2 id="🌈-features" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>🌈 Features</h2><ul><li>YAML config files, no CLI</li><li>Predictable</li><li>Incremental -&gt; Minimal space is used</li><li>Backup locations to multiple backends</li><li>Snapshot policies and pruning</li><li>Simple interface</li><li>Fully encrypted</li><li>Pre/After hooks</li><li>Exclude pattern/files</li><li>Backup &amp; Restore docker volumes</li><li><del>Seamless cron jobs for automatic backup</del> <a href="https://github.com/cupcakearmy/autorestic/issues/21">in development</a>.</li></ul><script id="orjaQRqhhr">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("orjaQRqhhr", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#autorestic" class="h1" data-content-highlight="autorestic">autorestic</a><a href="#✈️-roadmap" class="h2" data-content-highlight="✈️-roadmap">✈️ Roadmap</a><a href="#🌈-features" class="h2" data-content-highlight="🌈-features">🌈 Features</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="yKqvbTVB_P">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("yKqvbTVB_P", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="XfKCwZcXGT">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("XfKCwZcXGT", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="NDydHArUOB">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("NDydHArUOB", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="ujoxOtTdeq">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("ujoxOtTdeq", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="NEoElkGOBn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("NEoElkGOBn", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="PajDyKKpIm">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("PajDyKKpIm", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="BOFoKgmFqz">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("BOFoKgmFqz", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -1,56 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | 🛳 Installation</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="🛳-installation" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>🛳 Installation</h1><p>Linux &amp; macOS. Windows is not supported. If you have problems installing please open an issue :)</p><p>Autorestic requires <code>curl</code>, <code>wget</code> and <code>bzip2</code> to be installed. For most systems these should be already installed.</p><pre class=""><code class="bash code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span></span></span><div class="line-0-0-5 " data-content="curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash"><span class="lineCounter-0-0-4 prim">1</span><span class="token function">curl</span> -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh <span class="token operator">|</span> <span class="token function">bash</span></div><br></code></pre><script id="PrarcMVlUm">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("PrarcMVlUm", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#🛳-installation" class="h1" data-content-highlight="🛳-installation">🛳 Installation</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="mmGSdSjNoh">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("mmGSdSjNoh", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="SAbgJmyGtn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("SAbgJmyGtn", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="sgvTXhEsNC">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("sgvTXhEsNC", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="kESCMjMDfi">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("kESCMjMDfi", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="oaQCKDhxTo">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("oaQCKDhxTo", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="DsfglbUnDO">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("DsfglbUnDO", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="uoGxkBWILI">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("uoGxkBWILI", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1,57 +0,0 @@
<!DOCTYPE html><html><head><title>Autorestic | 🗂 Locations</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"><meta name="robots" content="index,follow"><meta name="theme-color" content="#212121"><meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"><link href="https://fonts.googleapis.com/css?family=Hind:400,700&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:300,400&amp;display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/icon?family=Material+Icons|Material+Icons+Outlined" rel="stylesheet"><style>
body, input, button {
font-family: 'Hind', sans-serif;
}
code, .hljs {
font-family: 'Source Code Pro', 'Courier New', Courier, monospace;
}
.icon-font {
font-family: 'Material Icons';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
/* Support for all WebKit browsers. */
-webkit-font-smoothing: antialiased;
/* Support for Safari and Chrome. */
text-rendering: optimizeLegibility;
/* Support for Firefox. */
-moz-osx-font-smoothing: grayscale;
/* Support for IE. */
font-feature-settings: 'liga';
}
.icon-font.outline {
font-family: 'Material Icons Outlined';
}
</style><link href="/autorestic/./dist/codedoc-styles.css" rel="stylesheet"><script async="" defer="" src="/autorestic/./dist/codedoc-bundle.js"></script></head><body><div class="header-0-0-9"><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><a class="github-button" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="false" data-show-count="true" data-size="false" href="https://github.com/cupcakearmy/autorestic/">Star</a><br><br><a class="watermark-0-0-8" href="https://github.com/CONNECT-platform/codedoc" target="_blank">Created With<svg viewBox="0 0 536 296" version="1.1" xmlns="http://www.w3.org/2000/svg"><g id="codedoc" transform="translate(-244.000000, -364.000000)" fill-rule="nonzero"><path d="M580,532 C615.346224,532 644,560.653776 644,596 C644,631.346224 615.346224,660 580,660 C544.653776,660 516,631.346224 516,596 C516,560.653776 544.653776,532 580,532 Z M716,532 C751.346224,532 780,560.653776 780,596 C780,631.346224 751.346224,660 716,660 L692,660 C687.581722,660 684,656.418278 684,652 C684,647.581722 687.581722,644 692,644 L716,644 C742.509668,644 764,622.509668 764,596 C764,569.490332 742.509668,548 716,548 L692,548 C687.581722,548 684,544.418278 684,540 C684,535.581722 687.581722,532 692,532 L716,532 Z M468,532 C472.418278,532 476,535.581722 476,540 L476,652 C476,656.418278 472.418278,660 468,660 L444,660 C408.653776,660 380,631.346224 380,596 C380,560.653776 408.653776,532 444,532 L468,532 Z M332,532 C336.418278,532 340,535.581722 340,540 L340,652 C340,656.418278 336.418278,660 332,660 L252,660 C247.581722,660 244,656.418278 244,652 L244,540 C244,535.581722 247.581722,532 252,532 L332,532 Z M580,548 C553.490332,548 532,569.490332 532,596 C532,622.509668 553.490332,644 580,644 C606.509668,644 628,622.509668 628,596 C628,569.490332 606.509668,548 580,548 Z M461,548 L444,548 C417.490332,548 396,569.490332 396,596 C396,622.509668 417.490332,644 444,644 L461,644 L461,548 Z M444,364 C479.346224,364 508,392.653776 508,428 C508,463.346224 479.346224,492 444,492 C408.653776,492 380,463.346224 380,428 C380,392.653776 408.653776,364 444,364 Z M332,364 C336.418278,364 340,367.581722 340,372 C340,376.418278 336.418278,380 332,380 L308,380 C281.490332,380 260,401.490332 260,428 C260,454.509668 281.490332,476 308,476 L332,476 C336.418278,476 340,479.581722 340,484 C340,488.418278 336.418278,492 332,492 L308,492 C272.653776,492 244,463.346224 244,428 C244,392.653776 272.653776,364 308,364 L332,364 Z M580,364 C615.346224,364 644,392.653776 644,428 C644,463.346224 615.346224,492 580,492 L556,492 C551.581722,492 548,488.418278 548,484 L548,372 C548,367.581722 551.581722,364 556,364 L580,364 Z M772,364 C776.418278,364 780,367.581722 780,372 C780,376.418278 776.418278,380 772,380 L700,380 L700,420 L772,420 C776.418278,420 780,423.581722 780,428 C780,432.418278 776.418278,436 772,436 L700,436 L700,476 L772,476 C776.418278,476 780,479.581722 780,484 C780,488.418278 776.418278,492 772,492 L692,492 C687.581722,492 684,488.418278 684,484 L684,372 C684,367.581722 687.581722,364 692,364 L772,364 Z M444,380 C417.490332,380 396,401.490332 396,428 C396,454.509668 417.490332,476 444,476 C470.509668,476 492,454.509668 492,428 C492,401.490332 470.509668,380 444,380 Z M580,380 L563,380 L563,476 L580,476 C606.509668,476 628,454.509668 628,428 C628,401.490332 606.509668,380 580,380 Z"></path></g></svg></a></div><div id="-codedoc-container" class="container"><h1 id="🗂-locations" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>🗂 Locations</h1><p>Locations can be seen as the input to the backup process. Generally this is simply a folder.
The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.</p><pre class="with-bar"><code class="yaml code-0-0-3" tabindex="0"><span class="wmbar-0-0-6"><span></span><span></span><span></span><span>.autorestic.yml</span></span><div class="line-0-0-5 " data-content="locations:"><span class="lineCounter-0-0-4 prim">1</span><span class="token key atrule">locations</span><span class="token punctuation">:</span></div><br><div class="line-0-0-5 " data-content=" my-location-name:"><span class="lineCounter-0-0-4">2</span> <span class="token key atrule">my-location-name</span><span class="token punctuation">:</span></div><br><div class="line-0-0-5 " data-content=" from: path/to/backup"><span class="lineCounter-0-0-4">3</span> <span class="token key atrule">from</span><span class="token punctuation">:</span> path/to/backup</div><br><div class="line-0-0-5 " data-content=" to:"><span class="lineCounter-0-0-4">4</span> <span class="token key atrule">to</span><span class="token punctuation">:</span></div><br><div class="line-0-0-5 " data-content=" - name-of-backend"><span class="lineCounter-0-0-4 prim">5</span> <span class="token punctuation">-</span> name<span class="token punctuation">-</span>of<span class="token punctuation">-</span>backend</div><br><div class="line-0-0-5 " data-content=" - also-backup-to-this-backend"><span class="lineCounter-0-0-4 prim">6</span> <span class="token punctuation">-</span> also<span class="token punctuation">-</span>backup<span class="token punctuation">-</span>to<span class="token punctuation">-</span>this<span class="token punctuation">-</span>backend</div><br></code></pre><h2 id="from" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span><code>from</code></h2><p>This is the source of the location.</p><h4 id="how-are-paths-resolved" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span>How are paths resolved?</h4><p>Paths can be absolute or relative. If relative they are resolved relative to the location of the config file. Tilde <code>~</code> paths are also supported for home folder resolution.</p><h2 id="to" class="heading-0-0-1"><span class="anchor-0-0-2" data-ignore-text=""><span class="icon-font" data-ignore-text="" style="vertical-align: sub">link</span></span><code>to</code></h2><p>This is einther a single backend or an array of backends. The backends have to be configured in the same config file.</p><script id="bCPgbOHOjf">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("bCPgbOHOjf", "qcaKEY878Mn2dFQW/lSrDg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="contentnav-0-0-14" data-no-search=""><a href="#🗂-locations" class="h1" data-content-highlight="🗂-locations">🗂 Locations</a><a href="#from" class="h2" data-content-highlight="from">from</a><a href="#how-are-paths-resolved" class="h4" data-content-highlight="how-are-paths-resolved">How are paths resolved?</a><a href="#to" class="h2" data-content-highlight="to">to</a></div></div><div id="-codedoc-toc" class="toc-0-0-11"><div class="content-0-0-12"><p><a href="/autorestic/">Home</a>
<a href="/autorestic/quick">Quick Start</a>
<a href="/autorestic/installation">Installation</a>
<a href="/autorestic/config">Configuration</a></p><div class="collapse-0-0-7 "><script id="cAMzSlpRfn">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("cAMzSlpRfn", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Locations</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/location/overview">Overview</a>
<a href="/autorestic/location/hooks">Hooks</a>
<a href="/autorestic/location/exclude">Exluding Files</a>
<a href="/autorestic/location/forget">Forget Policy</a>
<a href="/autorestic/location/cron">Cron</a>
<a href="/autorestic/location/docker">Docker Volumes</a></p></div></div><div class="collapse-0-0-7 "><script id="klBVMHflqG">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("klBVMHflqG", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">Backend</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/backend/overview">Overview</a>
<a href="/autorestic/backend/available">Available Backends</a></p></div></div><div class="collapse-0-0-7 "><script id="_PZSBXAPDM">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("_PZSBXAPDM", "fz894w7KG2/tX4kLbbA1Kg==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script><div class="label" onclick="this.parentElement.classList.toggle('open')"><span class="text">CLI</span><span class="icon-font closed">chevron_right</span></div><div class="content"><p><a href="/autorestic/cli/info">Info</a>
<a href="/autorestic/cli/check">Check</a>
<a href="/autorestic/cli/backup">Backup</a>
<a href="/autorestic/cli/restore">Restore</a>
<a href="/autorestic/cli/forget">Forget</a>
<a href="/autorestic/cli/cron">Cron</a>
<a href="/autorestic/cli/exec">Exec</a>
<a href="/autorestic/cli/install">Install</a>
<a href="/autorestic/cli/uninstall">Uninstall</a>
<a href="/autorestic/cli/update">Update</a></p></div></div><p><a href="/autorestic/examples">Examples</a></p><p><a href="/autorestic/qa">QA</a></p><p><a href="/autorestic/contrib">Contributors</a></p></div><div class="search-0-0-13"><script id="E_VqXDfnWf">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("E_VqXDfnWf", "+SrlfVhZ/PRQ5WhUlZbTaA==", {"repo":"autorestic","user":"cupcakearmy","root":"docs/md","pick":"\\.md$","drop":"(^_)|(\\/_)"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><div class="footer-0-0-10"><div class="left"><script id="EgVlVInxQk">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("EgVlVInxQk", "XsNW3ht5ee+RmVUActEo9g==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div><div class="main"><div class="inside"><a href="https://github.com/cupcakearmy/autorestic/" target="_blank">GitHub</a></div></div><div class="right"><script id="xwJIApIopb">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("xwJIApIopb", "Y1WWvCKxkgk1yh8xbCfXqw==", {});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></div></div><script id="cVBfLTXfgC">(function(){function load(){if (window.__sdh_transport){window.__sdh_transport("cVBfLTXfgC", "v641FmLj+AeGp0uuFTI6ug==", {"namespace":"/autorestic"});} }; if (document.readyState == 'complete') load(); else window.addEventListener('load', load); })()</script></body></html>

View File

@@ -2,13 +2,19 @@
[Quick Start](/quick)
[Installation](/installation)
[Configuration](/config)
[Upgrade](/upgrade)
> :Collapse label=Locations
>
> [Overview](/location/overview)
> [Hooks](/location/hooks)
> [Exluding Files](/location/exclude)
> [Forget Policy](/location/forget)
>
> > :Collapse label=Options
> >
> > [Overview](/location/options)
> > [Excluding Files](/location/exclude)
> > [Forget Policy](/location/forget)
>
> [Cron](/location/cron)
> [Docker Volumes](/location/docker)
@@ -16,11 +22,14 @@
>
> [Overview](/backend/overview)
> [Available Backends](/backend/available)
> [Options](/backend/options)
> :Collapse label=CLI
>
> [General](/cli/general)
> [Info](/cli/info)
> [Check](/cli/check)
> [Completion](/cli/completion)
> [Backup](/cli/backup)
> [Restore](/cli/restore)
> [Forget](/cli/forget)
@@ -28,7 +37,7 @@
> [Exec](/cli/exec)
> [Install](/cli/install)
> [Uninstall](/cli/uninstall)
> [Update](/cli/update)
> [Upgrade](/cli/upgrade)
[Examples](/examples)

View File

@@ -0,0 +1,85 @@
# Available Backends
In theory [all the restic backends](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html) are supported.
Those tested are the following:
## Local
```yaml
backends:
name-of-backend:
type: local
path: /data/my/backups
```
## Backblaze
```yaml
backends:
name-of-backend:
type: b2
path: 'backblaze_bucketID'
# Or With a path
# path: 'backblaze_bucketID:/some/path'
env:
B2_ACCOUNT_ID: 'backblaze_keyID'
B2_ACCOUNT_KEY: 'backblaze_applicationKey'
```
#### API Keys gotcha
If you use a _File name prefix_ when making the application key, do not include a leading slash. Make sure to include this prefix in the path (e.g. `path: 'backblaze_bucketID:my/path'`).
## S3 / Minio
```yaml
backends:
name-of-backend:
type: s3
path: s3.amazonaws.com/bucket_name
# Minio
# path: http://localhost:9000/bucket_name
env:
AWS_ACCESS_KEY_ID: my_key
AWS_SECRET_ACCESS_KEY: my_secret
```
## SFTP
For SFTP to work you need to use configure your host inside of ~/.ssh/config as password prompt is not supported. For more information on this topic please see the [official docs](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html#sftp) on the matter.
```yaml
backends:
name-of-backend:
type: sftp
path: my-host:/remote/path/on/the/server
```
## Rest Server
See [here](https://github.com/restic/rest-server) for how to install a rest server backend and [here](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) for further documentation.
```yaml
backends:
name-of-backend:
type: rest
path: http://localhost:8000/repo_name
# Or authenticated
path: https://user:pass@host:6969/path
```
Optionally you can set user and password separately
```yaml
backends:
rest:
type: rest
path: http://localhost:6969/path
key: ...
rest:
user: user
password: pass
```
> :ToCPrevNext

View File

@@ -0,0 +1,23 @@
# Options
For the `backup` and `forget` commands you can pass any native flags to `restic`.
> It is also possible to set options for an [a specific location](/location/options).
```yaml
backend:
foo:
type: ...
path: ...
options:
backup:
tag:
- foo
- bar
```
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
For more detail see the [location docs](/location/options) for options, as they are the same
> :ToCPrevNext

View File

@@ -1,6 +1,6 @@
# 💽 Backends
Backends are the ouputs of the backup process. Each location needs at least one.
Backends are the outputs of the backup process. Each location needs at least one.
```yaml | .autorestic.yml
backends:

View File

@@ -0,0 +1,17 @@
# Backup
```bash
autorestic backup [-l, --location] [-a, --all]
```
Performs a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
```bash
# All
autorestic backup -a
# Some
autorestic backup -l foo -l bar
```
> :ToCPrevNext

View File

@@ -0,0 +1,11 @@
# Check
```bash
autorestic check
```
Checks locations and backends are configured properly and initializes them if they are not already.
This is mostly an internal command, but useful to verify if a backend is configured correctly.
> :ToCPrevNext

View File

@@ -0,0 +1,17 @@
# Completion
```bash
autorestic completion [bash|zsh|fish|powershell]
```
Autorestic can generate shell completions automatically to make the experience even easier.
Supported shells are
- bash
- zsh
- fish
- powershell
To see how to install run `autorestic help completion` and follow the instructions for your specific shell
> :ToCPrevNext

13
docs/markdown/cli/cron.md Normal file
View File

@@ -0,0 +1,13 @@
# Cron
```bash
autorestic cron [--lean]
```
This command is mostly intended to be triggered by an automated system like systemd or crontab.
It will run cron jobs as [specified in the cron section](/location/cron) of a specific location.
The `--lean` flag will omit output like _skipping location x: not due yet_. This can be useful if you are dumping the output of the cron job to a log file and don't want to be overwhelmed by the output log.
> :ToCPrevNext

15
docs/markdown/cli/exec.md Normal file
View File

@@ -0,0 +1,15 @@
# Exec
```bash
autorestic exec [-b, --backend] [-a, --all] <command> -- [native options]
```
This is a very handy command which enables you to run any native restic command on desired backends. Generally you will want to include the verbose flag `-v, --verbose` to see the output. An example would be listing all the snapshots of all your backends:
```bash
autorestic exec -av -- snapshots
```
With `exec` you can basically run every cli command that you would be able to run with the restic cli. It only pre-fills path, key, etc.
> :ToCPrevNext

View File

@@ -0,0 +1,13 @@
# Forget
```bash
autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
```
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget).
The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
The `--prune` flag will also [prune the data](https://restic.readthedocs.io/en/latest/060_forget.html#removing-backup-snapshots). This is a costly operation that can take longer, however it will free up the actual space.
> :ToCPrevNext

View File

@@ -0,0 +1,38 @@
# General
## `-c, --config`
Specify the config file to be used.
If omitted `autorestic` will search for for a `.autorestic.yml` in the current directory and your home directory.
```bash
autorestic -c /path/to/my/config.yml
```
## `--ci`
Run the CLI in CI Mode, which means there will be no interactivity, no colors and automatically sets the `--verbose` flag.
This can be useful when you want to run cron e.g. as all the output will be saved.
```bash
autorestic --ci backup -a
```
## `-v, --verbose`
Verbose mode will show the output of the native restic commands that are otherwise not printed out. Useful for debugging or logging in automated tasks.
```bash
autorestic --verbose backup -a
```
## `--restic-bin`
With `--restic-bin` you can specify to run a specific restic binary. This can be useful if you want to [create a custom binary with root access that can be executed by any user](https://restic.readthedocs.io/en/stable/080_examples.html#full-backup-without-root).
```bash
autorestic --restic-bin /some/path/to/my/custom/restic/binary
```
> :ToCPrevNext

View File

@@ -1,7 +1,7 @@
# info
# Info
Displays the config file that autorestic is refering to.
Usefull when you want to quickly see what locations are being backuped where.
Displays the config file that autorestic is referring to.
Useful when you want to quickly see what locations are being backed-up where.
**Pro tip:** if it gets a bit long you can read it more easily with `autorestic info | less` 😉

View File

@@ -1,11 +1,13 @@
# Restore
```bash
autorestic restore [-l, --location] [--from backend] [--to <out dir>]
autorestic restore [-l, --location] [--from backend] [--to <out dir>] [-f, --force]
```
This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
The `--to` path has to be empty as no data will be overwritten by default. If you are sure you can pass the `-f, --force` flag and the data will be overwritten in the destination. However note that this will overwrite all the data existent in the backup, not only the 1 file that is missing e.g.
## Example
```bash

View File

@@ -1,6 +1,6 @@
# Uninstall
Installs both restic and autorestic from `/usr/local/bin`.
Uninstalls both restic and autorestic from `/usr/local/bin`.
```bash
autorestic uninstall

View File

@@ -0,0 +1,11 @@
# Upgrade
Autorestic can upgrade itself! Super handy right? Simply run autorestic upgrade and we will check for you if there are updates for restic and autorestic and install them if necessary.
```bash
autorestic upgrade
```
Updates both restic and autorestic automagically.
> :ToCPrevNext

16
docs/markdown/contrib.md Normal file
View File

@@ -0,0 +1,16 @@
# 🙋‍♀️🙋‍♂️ Contributors
This amazing people helped the project!
- @agateblue - Docs, Pruning, S3
- @david-boles - Docs
- @SebDanielsson - Brew
- @n194 - AUR Package
- @jin-park-dev - Typos
- @sumnerboy12 - Typos
- @FuzzyMistborn - Typos
- @ChanceM - Typos
- @TheForcer - Typos
- @themorlan - Typos
> :ToCPrevNext

17
docs/markdown/examples.md Normal file
View File

@@ -0,0 +1,17 @@
# 🐣 Examples
## List all the snapshots for all the backends
```bash
autorestic exec -av -- snapshots
```
## Unlock a locked repository
This can come in handy if a backup process crashed or if it was accidentally cancelled. Then the repository would still be locked without an actual process using it. Only do this if you know what you are doing and are sure no other process is actually reading/writing to the repository of course.
```bash
autorestic exec -b my-backend -- unlock
```
> :ToCPrevNext

22
docs/markdown/index.md Normal file
View File

@@ -0,0 +1,22 @@
# autorestic
High backup level CLI utility for [restic](https://restic.net/).
Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
> If you are coming from `0.x` see the [upgrade guide](/upgrade).
## 🌈 Features
- YAML config files, no CLI
- Incremental -> Minimal space is used
- Backup locations to multiple backends
- Snapshot policies and pruning
- Fully encrypted
- Pre/After hooks
- Exclude pattern/files
- Cron jobs for automatic backup
- Backup & Restore docker volumes
- Generated completions for `[bash|zsh|fish|powershell]`
> :ToCPrevNext

View File

@@ -0,0 +1,25 @@
# 🛳 Installation
Linux & macOS. Windows is not supported. If you have problems installing please open an issue :)
Autorestic requires `curl`, `wget` and `bzip2` to be installed. For most systems these should be already installed.
```bash
curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
```
## Alternatives
### Manual
You can download the right binary from the release page and simply copy it to `/usr/local/bin` or whatever path you prefer. Autoupdates will still work.
### Brew
If you are on macOS you can install through brew: `brew install autorestic`.
### AUR
If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) by @n194.
> :ToCPrevNext

View File

@@ -0,0 +1,49 @@
# Cron
Often it is usefully to trigger backups automatically. For this we can specify a `cron` attribute to each location.
```yaml | .autorestic.yml
locations:
my-location:
from: /data
to: my-backend
cron: '0 3 * * 0' # Every Sunday at 3:00
```
Here is a awesome website with [some examples](https://crontab.guru/examples.html) and an [explorer](https://crontab.guru/)
## Installing the cron
**This has to be done only once, regardless of now many cron jobs you have in your config file.**
To actually enable cron jobs you need something to call `autorestic cron` on a timed schedule.
Note that the schedule has nothing to do with the `cron` attribute in each location.
My advise would be to trigger the command every 5min, but if you have a cronjob that runs only once a week, it's probably enough to schedule it once a day.
### Crontab
Here is an example using crontab, but systemd would do too.
First, open your crontab in edit mode
```bash
crontab -e
```
Then paste this at the bottom of the file and save it. Note that in this specific example the config file is located at one of the default locations (e.g. `~/.autorestic.yml`). If your config is somewhere else you'll need to specify it using the `-c` option.
```bash
# This is required, as it otherwise cannot find restic as a command.
PATH="/usr/local/bin:/usr/bin:/bin"
# Example running every 5 minutes
*/5 * * * * autorestic --ci cron
```
> The `--ci` option is not required, but recommended
Now you can add as many `cron` attributes as you wish in the config file ⏱
> Also note that manually triggered backups with `autorestic backup` will not influence the cron timeline, they are willingly not linked.
> :ToCPrevNext

View File

@@ -0,0 +1,43 @@
# Docker
autorestic supports docker volumes directly, without needing them to be mounted to the host filesystem.
```yaml | docker-compose.yml
version: '3.7'
volumes:
data:
name: my-data
services:
api:
image: alpine
volumes:
- data:/foo/bar
```
```yaml | .autorestic.yml
locations:
- name: hello
from: volume:my-data
to:
- remote
backends:
- name: remote
# ...
```
Now you can backup and restore as always.
```bash
autorestic backup -l hello
```
```bash
autorestic restore -l hello
```
The volume has to exists whenever backing up or restoring.
> :ToCPrevNext

View File

@@ -1,6 +1,6 @@
# Excluding files
If you want to exclude certain files or folders it done easily by specifiyng the right flags in the location you desire to filter.
If you want to exclude certain files or folders it done easily by specifying the right flags in the location you desire to filter.
The flags are taken straight from the [restic cli exclude rules](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files) so you can use any flag used there.

View File

@@ -14,11 +14,11 @@ locations:
options:
forget:
keep-last: 5 # always keep at least 5 snapshots
keep-hourly: 3 # keep 3 last hourly shapshots
keep-daily: 4 # keep 4 last daily shapshots
keep-weekly: 1 # keep 1 last weekly shapshots
keep-monthly: 12 # keep 12 last monthly shapshots
keep-yearly: 7 # keep 7 last yearly shapshots
keep-hourly: 3 # keep 3 last hourly snapshots
keep-daily: 4 # keep 4 last daily snapshots
keep-weekly: 1 # keep 1 last weekly snapshots
keep-monthly: 12 # keep 12 last monthly snapshots
keep-yearly: 7 # keep 7 last yearly snapshots
keep-within: '2w' # keep snapshots from the last 2 weeks
```

View File

@@ -0,0 +1,42 @@
# Hooks
If you want to perform some commands before and/or after a backup, you can use hooks.
They consist of a list of commands that will be executed in the same directory as the target `from`.
The following hooks groups are supported, none are required:
- `before`
- `after`
- `failure`
- `success`
```yml | .autorestic.yml
locations:
my-location:
from: /data
to: my-backend
hooks:
before:
- echo "One"
- echo "Two"
- echo "Three"
after:
- echo "Byte"
failure:
- echo "Something went wrong"
success:
- echo "Well done!"
```
## Flowchart
1. `before` hook
2. Run backup
3. `after` hook
4. - `success` hook if no errors were found
- `failure` hook if at least error was encountered
If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
> :ToCPrevNext

View File

@@ -0,0 +1,21 @@
# Options
For the `backup` and `forget` commands you can pass any native flags to `restic`.
> It is also possible to set options for an [entire backend](/backend/options).
```yaml
locations:
foo:
path: ...
to: ...
options:
backup:
tag:
- foo
- bar
```
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
> :ToCPrevNext

View File

@@ -22,6 +22,6 @@ Paths can be absolute or relative. If relative they are resolved relative to the
## `to`
This is einther a single backend or an array of backends. The backends have to be configured in the same config file.
This is either a single backend or an array of backends. The backends have to be configured in the same config file.
> :ToCPrevNext

10
docs/markdown/qa.md Normal file
View File

@@ -0,0 +1,10 @@
# ❓ QA
## My config file was moved?
This happens when autorestic needs to write to the config file: e.g. when we are generating a key for you.
Unfortunately during this process formatting and comments are lost because the `yaml` library used is not comment and/or format aware.
That is why autorestic will place a copy of your old config next to the one we are writing to.
> :ToCPrevNext

View File

@@ -6,17 +6,23 @@
curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
```
See [installation](/installation) for alternative options.
## Write a simple config file
```bash
vim .autorestic.yml
vim ~/.autorestic.yml
```
For a quick overview:
- `locations` can be seen as the inputs and `backends` the output where the data is stored and backed up.
- One `location` can have one or multiple `backends` for redudancy.
- One `backend` can also be the target for multiple `locations`
- One `location` can have one or multiple `backends` for redundancy.
- One `backend` can also be the target for multiple `locations`.
> **⚠️ WARNING ⚠️**
>
> Note that the data is automatically encrypted on the server. The key will be generated and added to your config file. Every backend will have a separate key. **You should keep a copy of the keys or config file somewhere in case your server dies**. Otherwise DATA IS LOST!
```yaml | .autorestic.yml
locations:
@@ -34,22 +40,27 @@ backends:
remote:
type: s3
path: 's3.amazonaws.com/bucket_name'
AWS_ACCESS_KEY_ID: account_id
AWS_SECRET_ACCESS_KEY: account_key
key: some-random-password-198rc79r8y1029c8yfewj8f1u0ef87yh198uoieufy
env:
AWS_ACCESS_KEY_ID: account_id
AWS_SECRET_ACCESS_KEY: account_key
hdd:
type: local
path: /mnt/my_external_storage
key: 'if not key is set it will be generated for you'
```
## Check [Optional]
## Check
```bash
autorestic check -a
autorestic check
```
This checks if the config file has any issues. If this is the first time this can take longer as autorestic will setup the backends.
Now is good time to **backup the config**. After you run autorestic at least once we will add the generated encryption keys to the config.
## Backup
```bash

28
docs/markdown/upgrade.md Normal file
View File

@@ -0,0 +1,28 @@
# Upgrade
## From `0.x` to `1.0`
Most of the config file is remained compatible, however to clean up the backends custom environment variables were moved from the root object to an `env` object.
```yaml
# Before
remote:
type: b2
path: bucket:path/to/backup
key: some random encryption key
B2_ACCOUNT_ID: id
B2_ACCOUNT_KEY: key
# After
remote:
type: b2
path: bucket:path/to/backup
key: some random encryption key
env:
B2_ACCOUNT_ID: id
B2_ACCOUNT_KEY: key
```
Other than the config file there is a new `-v, --verbose` flag which shows the output of native commands, which are now hidden by default.
> :ToCPrevNext

Some files were not shown because too many files have changed in this diff Show More