mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2025-09-06 02:20:39 +00:00
Compare commits
16 Commits
b3b7c8df95
...
v1.7.11
Author | SHA1 | Date | |
---|---|---|---|
b5604b8b9f | |||
|
24220f6b62 | ||
ced20801c1 | |||
|
ce9140fa1e | ||
|
046c79fd15 | ||
|
f8603425d1 | ||
068121d722 | |||
8eea7d33f8 | |||
|
fc8b5fdbe2 | ||
|
f67bb7f73c | ||
|
530b1b646c | ||
|
3b57602fe8 | ||
|
045513234f | ||
|
78b0db50e0 | ||
|
62dd371d51 | ||
|
08766b75db |
4
.github/workflows/build.yml
vendored
4
.github/workflows/build.yml
vendored
@@ -3,7 +3,7 @@ name: Main
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- "v*.*.*"
|
- 'v*.*.*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
docker:
|
docker:
|
||||||
@@ -40,7 +40,7 @@ jobs:
|
|||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-go@v3
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version: "^1.20"
|
go-version: '^1.21'
|
||||||
- name: Build
|
- name: Build
|
||||||
run: go run build/build.go
|
run: go run build/build.go
|
||||||
- name: Release
|
- name: Release
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
FROM golang:1.20-alpine as builder
|
FROM golang:1.21-alpine as builder
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY go.* .
|
COPY go.* .
|
||||||
@@ -6,8 +6,8 @@ RUN go mod download
|
|||||||
COPY . .
|
COPY . .
|
||||||
RUN go build
|
RUN go build
|
||||||
|
|
||||||
FROM restic/restic:0.15.1
|
FROM restic/restic:0.16.4
|
||||||
RUN apk add --no-cache rclone bash
|
RUN apk add --no-cache rclone bash curl
|
||||||
COPY --from=builder /app/autorestic /usr/bin/autorestic
|
COPY --from=builder /app/autorestic /usr/bin/autorestic
|
||||||
ENTRYPOINT []
|
ENTRYPOINT []
|
||||||
CMD [ "autorestic" ]
|
CMD [ "autorestic" ]
|
||||||
|
40
cmd/root.go
40
cmd/root.go
@@ -55,28 +55,11 @@ func initConfig() {
|
|||||||
viper.SetConfigFile(cfgFile)
|
viper.SetConfigFile(cfgFile)
|
||||||
viper.AutomaticEnv()
|
viper.AutomaticEnv()
|
||||||
if viper.ConfigFileUsed() == "" {
|
if viper.ConfigFileUsed() == "" {
|
||||||
colors.Error.Println("cannot read config file %s\n", cfgFile)
|
colors.Error.Printf("cannot read config file %s\n", cfgFile)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
configPaths := []string{"."}
|
configPaths := getConfigPaths()
|
||||||
|
|
||||||
// Home
|
|
||||||
if home, err := homedir.Dir(); err == nil {
|
|
||||||
configPaths = append(configPaths, home)
|
|
||||||
}
|
|
||||||
|
|
||||||
// XDG_CONFIG_HOME
|
|
||||||
{
|
|
||||||
prefix, found := os.LookupEnv("XDG_CONFIG_HOME")
|
|
||||||
if !found {
|
|
||||||
if home, err := homedir.Dir(); err != nil {
|
|
||||||
prefix = filepath.Join(home, ".config")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
xdgConfig := filepath.Join(prefix, "autorestic")
|
|
||||||
configPaths = append(configPaths, xdgConfig)
|
|
||||||
}
|
|
||||||
for _, cfgPath := range configPaths {
|
for _, cfgPath := range configPaths {
|
||||||
viper.AddConfigPath(cfgPath)
|
viper.AddConfigPath(cfgPath)
|
||||||
}
|
}
|
||||||
@@ -88,3 +71,22 @@ func initConfig() {
|
|||||||
viper.AutomaticEnv()
|
viper.AutomaticEnv()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func getConfigPaths() []string {
|
||||||
|
result := []string{"."}
|
||||||
|
if home, err := homedir.Dir(); err == nil {
|
||||||
|
result = append(result, home)
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
xdgConfigHome, found := os.LookupEnv("XDG_CONFIG_HOME")
|
||||||
|
if !found {
|
||||||
|
if home, err := homedir.Dir(); err == nil {
|
||||||
|
xdgConfigHome = filepath.Join(home, ".config")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
xdgConfig := filepath.Join(xdgConfigHome, "autorestic")
|
||||||
|
result = append(result, xdgConfig)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
36
cmd/root_test.go
Normal file
36
cmd/root_test.go
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/mitchellh/go-homedir"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"slices"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
const xdgConfigHome = "XDG_CONFIG_HOME"
|
||||||
|
|
||||||
|
func assertContains(t *testing.T, array []string, element string) {
|
||||||
|
if !slices.Contains(array, element) {
|
||||||
|
t.Errorf("Expected %s to be contained in %s", element, array)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigResolving(t *testing.T) {
|
||||||
|
t.Run("~/.config/autorestic is used if XDG_CONFIG_HOME is not set", func(t *testing.T) {
|
||||||
|
// Override env using testing so that env gets restored after test
|
||||||
|
t.Setenv(xdgConfigHome, "")
|
||||||
|
_ = os.Unsetenv("XDG_CONFIG_HOME")
|
||||||
|
configPaths := getConfigPaths()
|
||||||
|
homeDir, _ := homedir.Dir()
|
||||||
|
expectedConfigPath := filepath.Join(homeDir, ".config/autorestic")
|
||||||
|
assertContains(t, configPaths, expectedConfigPath)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("XDG_CONFIG_HOME is respected if set", func(t *testing.T) {
|
||||||
|
t.Setenv(xdgConfigHome, "/foo/bar")
|
||||||
|
|
||||||
|
configPaths := getConfigPaths()
|
||||||
|
assertContains(t, configPaths, filepath.Join("/", "foo", "bar", "autorestic"))
|
||||||
|
})
|
||||||
|
}
|
@@ -1,15 +0,0 @@
|
|||||||
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']
|
|
||||||
}
|
|
||||||
});
|
|
@@ -1,24 +0,0 @@
|
|||||||
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',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
@@ -1,19 +0,0 @@
|
|||||||
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>;
|
|
||||||
}
|
|
@@ -1,21 +0,0 @@
|
|||||||
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>
|
|
||||||
)
|
|
||||||
}
|
|
@@ -1,57 +0,0 @@
|
|||||||
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>
|
|
||||||
)
|
|
||||||
}
|
|
@@ -1,8 +0,0 @@
|
|||||||
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);
|
|
4916
docs/.codedoc/package-lock.json
generated
4916
docs/.codedoc/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"dependencies": {
|
|
||||||
"@codedoc/core": "^0.3.2"
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,18 +0,0 @@
|
|||||||
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']
|
|
||||||
}
|
|
||||||
});
|
|
@@ -1,11 +0,0 @@
|
|||||||
import { createTheme } from '@codedoc/core/transport';
|
|
||||||
|
|
||||||
|
|
||||||
export const theme = /*#__PURE__*/createTheme({
|
|
||||||
light: {
|
|
||||||
primary: '#1eb2a6'
|
|
||||||
},
|
|
||||||
dark: {
|
|
||||||
primary: '#1eb2a6'
|
|
||||||
}
|
|
||||||
});
|
|
@@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"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": [
|
|
||||||
"./**/*"
|
|
||||||
]
|
|
||||||
}
|
|
@@ -1,22 +0,0 @@
|
|||||||
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
2
docs/.gitignore
vendored
@@ -1,2 +1,2 @@
|
|||||||
node_modules
|
node_modules
|
||||||
build
|
.next
|
||||||
|
1
docs/.nvmrc
Normal file
1
docs/.nvmrc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
v20.8.0
|
@@ -1,54 +0,0 @@
|
|||||||
[Home](/)
|
|
||||||
[Quick Start](/quick)
|
|
||||||
[Installation](/installation)
|
|
||||||
[Configuration](/config)
|
|
||||||
[Upgrade](/upgrade)
|
|
||||||
|
|
||||||
> :Collapse label=Locations
|
|
||||||
>
|
|
||||||
> [Overview](/location/overview)
|
|
||||||
> [Hooks](/location/hooks)
|
|
||||||
>
|
|
||||||
> > :Collapse label=Options
|
|
||||||
> >
|
|
||||||
> > [Overview](/location/options)
|
|
||||||
> > [Excluding Files](/location/exclude)
|
|
||||||
> > [Forget Policy](/location/forget)
|
|
||||||
> > [Copy](/location/copy)
|
|
||||||
>
|
|
||||||
> [Cron](/location/cron)
|
|
||||||
> [Docker Volumes](/location/docker)
|
|
||||||
|
|
||||||
> :Collapse label=Backend
|
|
||||||
>
|
|
||||||
> [Overview](/backend/overview)
|
|
||||||
> [Available Backends](/backend/available)
|
|
||||||
> [Options](/backend/options)
|
|
||||||
> [Environment](/backend/env)
|
|
||||||
|
|
||||||
> :Collapse label=CLI
|
|
||||||
>
|
|
||||||
> [General](/cli/general)
|
|
||||||
> [Info](/cli/info)
|
|
||||||
> [Check](/cli/check)
|
|
||||||
> [Completion](/cli/completion)
|
|
||||||
> [Backup](/cli/backup)
|
|
||||||
> [Restore](/cli/restore)
|
|
||||||
> [Forget](/cli/forget)
|
|
||||||
> [Cron](/cli/cron)
|
|
||||||
> [Exec](/cli/exec)
|
|
||||||
> [Install](/cli/install)
|
|
||||||
> [Uninstall](/cli/uninstall)
|
|
||||||
> [Upgrade](/cli/upgrade)
|
|
||||||
|
|
||||||
> :Collapse label=Migration
|
|
||||||
>
|
|
||||||
> [0.x → 1.0](/migration/0.x_1.0)
|
|
||||||
> [1.4 → 1.5](/migration/1.4_1.5)
|
|
||||||
|
|
||||||
[Examples](/examples)
|
|
||||||
[Docker](/docker)
|
|
||||||
[QA](/qa)
|
|
||||||
[Community](/community)
|
|
||||||
[Contributors](/contrib)
|
|
||||||
|
|
6
docs/next.config.js
Normal file
6
docs/next.config.js
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
const withNextra = require('nextra')({
|
||||||
|
theme: 'nextra-theme-docs',
|
||||||
|
themeConfig: './theme.config.jsx',
|
||||||
|
})
|
||||||
|
|
||||||
|
module.exports = withNextra()
|
2741
docs/package-lock.json
generated
2741
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,10 +1,14 @@
|
|||||||
{
|
{
|
||||||
"private": true,
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "codedoc install && codedoc build",
|
"build": "NEXT_TELEMETRY_DISABLED=1 next build",
|
||||||
"dev": "codedoc serve"
|
"dev": "NEXT_TELEMETRY_DISABLED=1 next"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@codedoc/cli": "^0.3.0"
|
"next": "^13.5.3",
|
||||||
}
|
"nextra": "^2.13.1",
|
||||||
|
"nextra-theme-docs": "^2.13.1",
|
||||||
|
"react": "^18.2.0",
|
||||||
|
"react-dom": "^18.2.0"
|
||||||
|
},
|
||||||
|
"packageManager": "pnpm@8.8.0"
|
||||||
}
|
}
|
||||||
|
10
docs/pages/_meta.json
Normal file
10
docs/pages/_meta.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"index": "Home",
|
||||||
|
"quick": "Quick Start",
|
||||||
|
"installation": "Installation",
|
||||||
|
"config": "Configuration",
|
||||||
|
"location": "Locations",
|
||||||
|
"backend": "Backend",
|
||||||
|
"cli": "CLI",
|
||||||
|
"migration": "Migration"
|
||||||
|
}
|
6
docs/pages/backend/_meta.json
Normal file
6
docs/pages/backend/_meta.json
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"index": "Overview",
|
||||||
|
"available": "Available backends",
|
||||||
|
"options": "Options",
|
||||||
|
"env": "Environment"
|
||||||
|
}
|
@@ -83,5 +83,3 @@ backends:
|
|||||||
user: user
|
user: user
|
||||||
password: pass
|
password: pass
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -63,5 +63,3 @@ backends:
|
|||||||
type: b2
|
type: b2
|
||||||
path: myBucket
|
path: myBucket
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -16,5 +16,3 @@ backends:
|
|||||||
## Types
|
## Types
|
||||||
|
|
||||||
We restic supports multiple types of backends. See the [full list](/backend/available) for details.
|
We restic supports multiple types of backends. See the [full list](/backend/available) for details.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -15,5 +15,3 @@ backend:
|
|||||||
```
|
```
|
||||||
|
|
||||||
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
|
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
3
docs/pages/cli/_meta.json
Normal file
3
docs/pages/cli/_meta.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"general": "General"
|
||||||
|
}
|
@@ -21,5 +21,3 @@ autorestic backup -l foo -l bar
|
|||||||
```bash
|
```bash
|
||||||
autorestic backup -l location@backend
|
autorestic backup -l location@backend
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -7,5 +7,3 @@ autorestic check
|
|||||||
Checks locations and backends are configured properly and initializes them if they are not already.
|
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.
|
This is mostly an internal command, but useful to verify if a backend is configured correctly.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -13,5 +13,3 @@ Supported shells are
|
|||||||
- powershell
|
- powershell
|
||||||
|
|
||||||
To see how to install run `autorestic help completion` and follow the instructions for your specific shell
|
To see how to install run `autorestic help completion` and follow the instructions for your specific shell
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -9,5 +9,3 @@ This command is mostly intended to be triggered by an automated system like syst
|
|||||||
It will run cron jobs as [specified in the cron section](/location/cron) of a specific location.
|
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.
|
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
|
|
@@ -11,5 +11,3 @@ 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.
|
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
|
|
@@ -4,10 +4,8 @@
|
|||||||
autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
|
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).
|
This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/options/forget).
|
||||||
|
|
||||||
The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
|
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.
|
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
|
|
@@ -34,5 +34,3 @@ With `--restic-bin` you can specify to run a specific restic binary. This can be
|
|||||||
```bash
|
```bash
|
||||||
autorestic --restic-bin /some/path/to/my/custom/restic/binary
|
autorestic --restic-bin /some/path/to/my/custom/restic/binary
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -14,5 +14,3 @@ autorestic info
|
|||||||
```bash
|
```bash
|
||||||
autorestic -c path/to/some/config.yml info
|
autorestic -c path/to/some/config.yml info
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -5,5 +5,3 @@ Installs both restic and autorestic to `/usr/local/bin`.
|
|||||||
```bash
|
```bash
|
||||||
autorestic install
|
autorestic install
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -15,5 +15,3 @@ autorestic restore -l home --from hdd --to /path/where/to/restore
|
|||||||
```
|
```
|
||||||
|
|
||||||
This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
|
This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -5,5 +5,3 @@ Uninstalls both restic and autorestic from `/usr/local/bin`.
|
|||||||
```bash
|
```bash
|
||||||
autorestic uninstall
|
autorestic uninstall
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -7,5 +7,3 @@ autorestic upgrade
|
|||||||
```
|
```
|
||||||
|
|
||||||
Updates both restic and autorestic automagically.
|
Updates both restic and autorestic automagically.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -9,5 +9,3 @@ A list of community driven projects. (No official affiliation)
|
|||||||
- Ansible Role: <https://github.com/FuzzyMistborn/ansible-role-autorestic>
|
- Ansible Role: <https://github.com/FuzzyMistborn/ansible-role-autorestic>
|
||||||
- Ansible Role: <https://0xacab.org/varac-projects/ansible-role-autorestic>
|
- Ansible Role: <https://0xacab.org/varac-projects/ansible-role-autorestic>
|
||||||
- Ansible Role: <https://github.com/dbrennand/ansible-role-autorestic>
|
- Ansible Role: <https://github.com/dbrennand/ansible-role-autorestic>
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -2,10 +2,11 @@
|
|||||||
|
|
||||||
## Path
|
## Path
|
||||||
|
|
||||||
By default autorestic searches for a `.autorestic.yml` file in the current directory and your home folder.
|
By default autorestic searches for a `.autorestic.yml` file in the current directory, your home folder and your XDG config folder (`~/.config/` by default):
|
||||||
|
|
||||||
- `./.autorestic.yml`
|
- `./.autorestic.yml`
|
||||||
- `~/.autorestic.yml`
|
- `~/.autorestic.yml`
|
||||||
|
- `~/.config/autorestic/.autorestic.yml`
|
||||||
|
|
||||||
You can also specify a custom file with the `-c path/to/some/config.yml`
|
You can also specify a custom file with the `-c path/to/some/config.yml`
|
||||||
|
|
||||||
@@ -83,5 +84,3 @@ locations:
|
|||||||
forget:
|
forget:
|
||||||
<<: *bar
|
<<: *bar
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -17,5 +17,3 @@ This amazing people helped the project!
|
|||||||
- @TheForcer - Typos.
|
- @TheForcer - Typos.
|
||||||
- @themorlan - Typos.
|
- @themorlan - Typos.
|
||||||
- @somebox - Typos.
|
- @somebox - Typos.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -36,5 +36,3 @@ locations:
|
|||||||
to:
|
to:
|
||||||
- somewhere-else
|
- somewhere-else
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -18,5 +18,3 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
|
|||||||
- Cron jobs for automatic backup
|
- Cron jobs for automatic backup
|
||||||
- Backup & Restore docker volumes
|
- Backup & Restore docker volumes
|
||||||
- Generated completions for `[bash|zsh|fish|powershell]`
|
- Generated completions for `[bash|zsh|fish|powershell]`
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -24,8 +24,10 @@ You can download the right binary from the release page and simply copy it to `/
|
|||||||
|
|
||||||
If you are on macOS you can install through brew: `brew install autorestic`.
|
If you are on macOS you can install through brew: `brew install autorestic`.
|
||||||
|
|
||||||
|
### Fedora
|
||||||
|
|
||||||
|
Fedora users can install the [autorestic](https://src.fedoraproject.org/rpms/autorestic/) package with `dnf install autorestic`.
|
||||||
|
|
||||||
### AUR
|
### AUR
|
||||||
|
|
||||||
~~If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) (looking for maintainers).~~ - Deprecated
|
If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/)
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
7
docs/pages/location/_meta.json
Normal file
7
docs/pages/location/_meta.json
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"index": "Overview",
|
||||||
|
"hooks": "Hooks",
|
||||||
|
"options": "Options",
|
||||||
|
"cron": "Cronjobs",
|
||||||
|
"docker": "Docker volumes"
|
||||||
|
}
|
@@ -1,6 +1,6 @@
|
|||||||
# Cron
|
# Cron
|
||||||
|
|
||||||
Often it is usefully to trigger backups automatically. For this we can specify a `cron` attribute to each location.
|
Often it is useful to trigger backups automatically. For this, we can specify a `cron` attribute to each location.
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
locations:
|
locations:
|
||||||
@@ -10,15 +10,15 @@ locations:
|
|||||||
cron: '0 3 * * 0' # Every Sunday at 3:00
|
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/)
|
Here is an awesome website with [some examples](https://crontab.guru/examples.html) and an [explorer](https://crontab.guru/).
|
||||||
|
|
||||||
## Installing the cron
|
## Installing the cron
|
||||||
|
|
||||||
**This has to be done only once, regardless of now many cron jobs you have in your config file.**
|
**This has to be done only once, regardless of how 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.
|
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.
|
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.
|
My advice 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
|
### Crontab
|
||||||
|
|
||||||
@@ -50,6 +50,4 @@ To debug a cron job you can use
|
|||||||
|
|
||||||
Now you can add as many `cron` attributes as you wish in the config file ⏱
|
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.
|
> Also note that manually triggered backups with `autorestic backup` will not influence the cron timeline, they are intentionally not linked.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -35,5 +35,3 @@ autorestic restore -l hello
|
|||||||
```
|
```
|
||||||
|
|
||||||
The volume has to exists whenever backing up or restoring.
|
The volume has to exists whenever backing up or restoring.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -76,5 +76,3 @@ AUTORESTIC_LOCATION=bar
|
|||||||
AUTORESTIC_FILES_ADDED_0=42
|
AUTORESTIC_FILES_ADDED_0=42
|
||||||
AUTORESTIC_FILES_ADDED_FOO=42
|
AUTORESTIC_FILES_ADDED_FOO=42
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -4,6 +4,7 @@ Locations can be seen as the input to the backup process. Generally this is simp
|
|||||||
The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.
|
The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.
|
||||||
|
|
||||||
Note: names of locations MUST be lower case!
|
Note: names of locations MUST be lower case!
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
version: 2
|
version: 2
|
||||||
|
|
||||||
@@ -30,5 +31,3 @@ Paths can be absolute or relative. If relative they are resolved relative to the
|
|||||||
## `to`
|
## `to`
|
||||||
|
|
||||||
This is either 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
|
|
3
docs/pages/location/options/_meta.json
Normal file
3
docs/pages/location/options/_meta.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"index": "Overview"
|
||||||
|
}
|
@@ -16,5 +16,3 @@ locations:
|
|||||||
- '*.abc'
|
- '*.abc'
|
||||||
exclude-file: .gitignore
|
exclude-file: .gitignore
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -53,5 +53,3 @@ locations:
|
|||||||
forget:
|
forget:
|
||||||
keep-last: 5
|
keep-last: 5
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -63,5 +63,3 @@ backends:
|
|||||||
locations:
|
locations:
|
||||||
# ...
|
# ...
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -22,5 +22,3 @@ remote:
|
|||||||
```
|
```
|
||||||
|
|
||||||
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.
|
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
|
|
@@ -64,5 +64,3 @@ Autorestic changed the way backups are referenced. Before we took the paths as t
|
|||||||
```bash
|
```bash
|
||||||
autorestic exec -va -- tag --add ar:location:LOCATION_NAME # Only if you have only one location
|
autorestic exec -va -- tag --add ar:location:LOCATION_NAME # Only if you have only one location
|
||||||
```
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
4
docs/pages/migration/_meta.json
Normal file
4
docs/pages/migration/_meta.json
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"0.x_1.0": "0.x → 1.0",
|
||||||
|
"1.4_1.5": "1.4 → 1.5"
|
||||||
|
}
|
@@ -6,5 +6,3 @@ This happens when autorestic needs to write to the config file: e.g. when we are
|
|||||||
Unfortunately during this process formatting and comments are lost because the `yaml` library used is not comment and/or format aware.
|
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.
|
That is why autorestic will place a copy of your old config next to the one we are writing to.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
@@ -82,5 +82,3 @@ autorestic restore -l home --from hdd --to /path/where/to/restore
|
|||||||
```
|
```
|
||||||
|
|
||||||
This will restore the location `home` from the backend `hdd` to the given path.
|
This will restore the location `home` from the backend `hdd` to the given path.
|
||||||
|
|
||||||
> :ToCPrevNext
|
|
3044
docs/pnpm-lock.yaml
generated
Normal file
3044
docs/pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
24
docs/theme.config.jsx
Normal file
24
docs/theme.config.jsx
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
export default {
|
||||||
|
logo: <span>Autorestic</span>,
|
||||||
|
docsRepositoryBase: 'https://github.com/cupcakearmy/autorestic/tree/master/docs',
|
||||||
|
project: {
|
||||||
|
link: 'https://github.com/cupcakearmy/autorestic',
|
||||||
|
},
|
||||||
|
sidebar: {
|
||||||
|
defaultMenuCollapseLevel: 1,
|
||||||
|
},
|
||||||
|
feedback: {
|
||||||
|
content: 'Question? An error? Give feedback →',
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
text: (
|
||||||
|
<span>
|
||||||
|
MIT {new Date().getFullYear()} ©{' '}
|
||||||
|
<a href="https://github.com/cupcakearmy" target="_blank">
|
||||||
|
cupcakearmy
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</span>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"cleanUrls": true
|
|
||||||
}
|
|
2
go.mod
2
go.mod
@@ -1,6 +1,6 @@
|
|||||||
module github.com/cupcakearmy/autorestic
|
module github.com/cupcakearmy/autorestic
|
||||||
|
|
||||||
go 1.20
|
go 1.21
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/blang/semver/v4 v4.0.0
|
github.com/blang/semver/v4 v4.0.0
|
||||||
|
@@ -17,7 +17,7 @@ import (
|
|||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
)
|
)
|
||||||
|
|
||||||
const VERSION = "1.7.7"
|
const VERSION = "1.7.11"
|
||||||
|
|
||||||
type OptionMap map[string][]interface{}
|
type OptionMap map[string][]interface{}
|
||||||
type Options map[string]OptionMap
|
type Options map[string]OptionMap
|
||||||
|
Reference in New Issue
Block a user