resticc

Restic with configuration files
Log | Files | Refs | README

resticc.1 (2322B)

      1 ./"
      2 ./" Copyright (c) 2026 Jacob R. Edwards <jacob@jacobedwards.org>
      3 ./"
      4 ./" Permission to use, copy, modify, and distribute this software for any
      5 ./" purpose with or without fee is hereby granted, provided that the above
      6 ./" copyright notice and this permission notice appear in all copies.
      7 ./"
      8 ./" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIE
      9 ./" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     10 ./" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     11 ./" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     12 ./" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     13 ./" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     14 ./" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     15 ./"
     16 .Dd January 21, 2026
     17 .Dt RESTICC 1
     18 .Os
     19 .Sh NAME
     20 .Nm resticc
     21 .Nd restic configuration
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Ar repository
     25 .Op Ar restic_args
     26 .Nm
     27 .Ar repository Ar config
     28 .Nm
     29 .Ar repository Ar bucket Ar name Op Ar prefix
     30 .Sh DESCRIPTION
     31 .Nm
     32 provides configuration files for
     33 .Xr restic 1
     34 to load repository locations and keys from. It's usage is the same as
     35 .Xr restic 1
     36 with the addition of the
     37 .Ar config
     38 and
     39 .Ar bucket
     40 commands. The
     41 .Ar config
     42 command displays the loaded configuration, and
     43 .Ar bucket
     44 displays the hashed bucket name.
     45 .Sh ENVIRONMENT
     46 .Bl -tag -width Ds
     47 .It Ev RESTIC_PASSWORD
     48 Override the encryption key.
     49 .It Ev RESTIC_REPOSITORY
     50 Override the repository URL.
     51 .It Ev AWS_ACCESS_KEY_ID
     52 Override the application key id. (Key will be loaded from the keys
     53 directory based on this.)
     54 .It Ev AWS_SECRET_ACCESS_KEY
     55 Override the application key data.
     56 .Sh FILES
     57 .Bl -tag -width Ds
     58 .It Pa /etc/resticc/prefix
     59 Bucket prefix.
     60 .It Pa /etc/resticc/$repository/host
     61 Repository host.
     62 .It Pa /etc/resticc/$repository/path
     63 Bucket path.
     64 .It Pa /etc/resticc/$repository/keys/restic
     65 Restic encryption key.
     66 .It Pa /etc/resticc/$repository/keys/app/
     67 Directory containing restic application keys named by their ID.
     68 .El
     69 .Sh EXIT STATUS
     70 .Ex -std
     71 .Sh EXAMPLES
     72 .Pp
     73 Run
     74 .Xr restic-ls(1)
     75 on the
     76 .Qq backup
     77 repository's latest snapshot:
     78 .Pp
     79 .Dl $ resticc backup ls latest
     80 .Pp
     81 Get the bucket name for
     82 .Qq backup :
     83 .Dl $ resticc backup bucket
     84 .Sh SEE ALSO
     85 .Xr restic 1
     86 .Sh AUTHORS
     87 .An Jacob R. Edwards Aq Mt jacob@jacobedwards.org