Merge 0c7da11f4d into 8eea7d33f8

* delete old docs

* new docs

docs/.codedoc/build.ts

@@ -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']
-  }
-});

docs/.codedoc/config.ts

@@ -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',
-    },
-  },
-})

docs/.codedoc/content/footer.tsx

@@ -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>;
-}

docs/.codedoc/content/header.tsx

@@ -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>
-  )
-}

docs/.codedoc/content/index.tsx

@@ -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>
-  )
-}

docs/.codedoc/content/theme.ts

@@ -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);

docs/.codedoc/package.json

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

docs/.codedoc/serve.ts

@@ -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']
-  }
-});

docs/.codedoc/theme.ts

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

docs/.codedoc/tsconfig.json

@@ -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": [
-    "./**/*"
-  ]
-}

docs/.codedoc/watch.ts

@@ -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', () => {});
-}

docs/.gitignore

@@ -1,2 +1,2 @@
 node_modules
-build
+.next

docs/.nvmrc

@@ -0,0 +1 @@
+v20.8.0

docs/markdown/_toc.md

@@ -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)
-

docs/next.config.js

@@ -0,0 +1,6 @@
+const withNextra = require('nextra')({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.jsx',
+})
+
+module.exports = withNextra()

docs/package.json

@@ -1,10 +1,14 @@
 {
-  "private": true,
   "scripts": {
-    "build": "codedoc install && codedoc build",
+    "build": "NEXT_TELEMETRY_DISABLED=1 next build",
-    "dev": "codedoc serve"
+    "dev": "NEXT_TELEMETRY_DISABLED=1 next"
   },
   "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"
 }

docs/pages/_meta.json

@@ -0,0 +1,10 @@
+{
+  "index": "Home",
+  "quick": "Quick Start",
+  "installation": "Installation",
+  "config": "Configuration",
+  "location": "Locations",
+  "backend": "Backend",
+  "cli": "CLI",
+  "migration": "Migration"
+}

docs/pages/backend/_meta.json

@@ -0,0 +1,6 @@
+{
+  "index": "Overview",
+  "available": "Available backends",
+  "options": "Options",
+  "env": "Environment"
+}

docs/pages/backend/available.md

@@ -83,5 +83,3 @@ backends:
       user: user
       password: pass
 ```
-
-> :ToCPrevNext

docs/pages/backend/env.md

@@ -63,5 +63,3 @@ backends:
     type: b2
     path: myBucket
 ```
-
-> :ToCPrevNext

docs/pages/backend/index.md

@@ -16,5 +16,3 @@ backends:
 ## Types
 
 We restic supports multiple types of backends. See the [full list](/backend/available) for details.
-
-> :ToCPrevNext

docs/pages/backend/options.md

@@ -15,5 +15,3 @@ backend:
 ```
 
 In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
-
-> :ToCPrevNext

docs/pages/cli/_meta.json

@@ -0,0 +1,3 @@
+{
+  "general": "General"
+}

docs/pages/cli/backup.md

@@ -21,5 +21,3 @@ autorestic backup -l foo -l bar
 ```bash
 autorestic backup -l location@backend
 ```
-
-> :ToCPrevNext

docs/pages/cli/check.md

@@ -7,5 +7,3 @@ 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

docs/pages/cli/completion.md

@@ -13,5 +13,3 @@ Supported shells are
 - powershell
 
 To see how to install run `autorestic help completion` and follow the instructions for your specific shell
-
-> :ToCPrevNext

docs/pages/cli/cron.md

@@ -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.
 
 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

docs/pages/cli/exec.md

@@ -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.
-
-> :ToCPrevNext

docs/pages/cli/forget.md

@@ -9,5 +9,3 @@ This will prune and remove old data form the backends according to the [keep pol
 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

docs/pages/cli/general.md

@@ -34,5 +34,3 @@ With `--restic-bin` you can specify to run a specific restic binary. This can be
 ```bash
 autorestic --restic-bin /some/path/to/my/custom/restic/binary
 ```
-
-> :ToCPrevNext

docs/pages/cli/info.md

@@ -14,5 +14,3 @@ autorestic info
 ```bash
 autorestic -c path/to/some/config.yml info
 ```
-
-> :ToCPrevNext

docs/pages/cli/install.md

@@ -5,5 +5,3 @@ Installs both restic and autorestic to `/usr/local/bin`.
 ```bash
 autorestic install
 ```
-
-> :ToCPrevNext

docs/pages/cli/restore.md

@@ -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`
-
-> :ToCPrevNext

docs/pages/cli/uninstall.md

@@ -5,5 +5,3 @@ Uninstalls both restic and autorestic from `/usr/local/bin`.
 ```bash
 autorestic uninstall
 ```
-
-> :ToCPrevNext

docs/pages/cli/upgrade.md

@@ -7,5 +7,3 @@ autorestic upgrade
 ```
 
 Updates both restic and autorestic automagically.
-
-> :ToCPrevNext

docs/pages/community.md

@@ -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://0xacab.org/varac-projects/ansible-role-autorestic>
 - Ansible Role: <https://github.com/dbrennand/ansible-role-autorestic>
-
-> :ToCPrevNext

docs/pages/config.md

@@ -83,5 +83,3 @@ locations:
       forget:
         <<: *bar
 ```
-
-> :ToCPrevNext

docs/pages/contributors.md

@@ -17,5 +17,3 @@ This amazing people helped the project!
 - @TheForcer - Typos.
 - @themorlan - Typos.
 - @somebox - Typos.
-
-> :ToCPrevNext

docs/pages/examples.md

@@ -36,5 +36,3 @@ locations:
     to:
       - somewhere-else
 ```
-
-> :ToCPrevNext

docs/pages/index.md

@@ -18,5 +18,3 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Cron jobs for automatic backup
 - Backup & Restore docker volumes
 - Generated completions for `[bash|zsh|fish|powershell]`
-
-> :ToCPrevNext

docs/pages/installation.md

@@ -31,5 +31,3 @@ Fedora users can install the [autorestic](https://src.fedoraproject.org/rpms/aut
 ### AUR
 
 ~~If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) (looking for maintainers).~~ - Deprecated
-
-> :ToCPrevNext

docs/pages/location/_meta.json

@@ -0,0 +1,7 @@
+{
+  "index": "Overview",
+  "hooks": "Hooks",
+  "options": "Options",
+  "cron": "Cronjobs",
+  "docker": "Docker volumes"
+}

docs/pages/location/cron.md

@@ -1,6 +1,6 @@
 # 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
 locations:
@@ -10,15 +10,15 @@ locations:
     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
 
-**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.
 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
 
@@ -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 ⏱
 
-> 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

docs/pages/location/docker.md

@@ -35,5 +35,3 @@ autorestic restore -l hello
 ```
 
 The volume has to exists whenever backing up or restoring.
-
-> :ToCPrevNext

docs/pages/location/hooks.md

@@ -76,5 +76,3 @@ AUTORESTIC_LOCATION=bar
 AUTORESTIC_FILES_ADDED_0=42
 AUTORESTIC_FILES_ADDED_FOO=42
 ```
-
-> :ToCPrevNext

docs/pages/location/index.md

@@ -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.
 
 Note: names of locations MUST be lower case!
+
 ```yaml | .autorestic.yml
 version: 2
 
@@ -30,5 +31,3 @@ Paths can be absolute or relative. If relative they are resolved relative to the
 ## `to`
 
 This is either a single backend or an array of backends. The backends have to be configured in the same config file.
-
-> :ToCPrevNext

docs/pages/location/options/_meta.json

@@ -0,0 +1,3 @@
+{
+  "index": "Overview"
+}

docs/pages/location/options/exclude.md

@@ -16,5 +16,3 @@ locations:
           - '*.abc'
         exclude-file: .gitignore
 ```
-
-> :ToCPrevNext

docs/pages/location/options/forget.md

@@ -53,5 +53,3 @@ locations:
       forget:
         keep-last: 5
 ```
-
-> :ToCPrevNext

docs/pages/location/options/index.md

@@ -63,5 +63,3 @@ backends:
 locations:
   # ...
 ```
-
-> :ToCPrevNext

docs/pages/migration/0.x_1.0.md

@@ -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.
-
-> :ToCPrevNext

docs/pages/migration/1.4_1.5.md

@@ -64,5 +64,3 @@ Autorestic changed the way backups are referenced. Before we took the paths as t
 ```bash
 autorestic exec -va -- tag --add ar:location:LOCATION_NAME # Only if you have only one location
 ```
-
-> :ToCPrevNext

docs/pages/migration/_meta.json

@@ -0,0 +1,4 @@
+{
+  "0.x_1.0": "0.x → 1.0",
+  "1.4_1.5": "1.4 → 1.5"
+}

docs/pages/qa.md

@@ -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.
 
 That is why autorestic will place a copy of your old config next to the one we are writing to.
-
-> :ToCPrevNext

docs/pages/quick.md

@@ -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.
-
-> :ToCPrevNext

docs/theme.config.jsx

@@ -0,0 +1,24 @@
+export default {
+  logo: <span>Autorestic</span>,
+  docsRepositoryBase: 'https://github.com/cupcakearmy/autorestic/blob/main',
+  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>
+    ),
+  },
+}

docs/vercel.json

@@ -1,3 +0,0 @@
-{
-  "cleanUrls": true
-}

internal/config.go

@@ -17,7 +17,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.7.7"
+const VERSION = "1.7.9"
 
 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap