Release 2.4.0
Update version number and update documentation * Support multiple keys in `yadm.gpg-recipient` (#139) * Ensure all templates are written atomically (#142) * Add encrypt_with_checksums to the hooks collection (#188) * Escape white space in YADM_HOOK_FULL_COMMAND (#187) * Improve parsing of os-release (#194) * Improve identification of WSL (#196) * Fix troff warnings emitted by man page (#195) * Write encrypt-based exclusions during decrypt
This commit is contained in:
parent
79e93e38bc
commit
dd86c8a691
10 changed files with 121 additions and 105 deletions
9
CHANGES
9
CHANGES
|
@ -1,3 +1,12 @@
|
||||||
|
2.4.0
|
||||||
|
* Support multiple keys in `yadm.gpg-recipient` (#139)
|
||||||
|
* Ensure all templates are written atomically (#142)
|
||||||
|
* Add encrypt_with_checksums to the hooks collection (#188)
|
||||||
|
* Escape white space in YADM_HOOK_FULL_COMMAND (#187)
|
||||||
|
* Improve parsing of os-release (#194)
|
||||||
|
* Improve identification of WSL (#196)
|
||||||
|
* Fix troff warnings emitted by man page (#195)
|
||||||
|
* Write encrypt-based exclusions during decrypt
|
||||||
2.3.0
|
2.3.0
|
||||||
* Support git-crypt (#168)
|
* Support git-crypt (#168)
|
||||||
* Support specifying a command after `yadm enter`
|
* Support specifying a command after `yadm enter`
|
||||||
|
|
|
@ -1,25 +1,29 @@
|
||||||
CONTRIBUTORS
|
CONTRIBUTORS
|
||||||
|
|
||||||
Tim Byrne
|
Tim Byrne
|
||||||
Espen Henriksen
|
Martin Zuther
|
||||||
Ross Smith II
|
Ross Smith II
|
||||||
|
Espen Henriksen
|
||||||
Cameron Eagans
|
Cameron Eagans
|
||||||
Klas Mellbourn
|
Klas Mellbourn
|
||||||
David Mandelberg
|
David Mandelberg
|
||||||
Daniel Gray
|
Daniel Gray
|
||||||
Jan Schulz
|
Jan Schulz
|
||||||
Siôn Le Roux
|
Siôn Le Roux
|
||||||
|
Stig Palmquist
|
||||||
Sébastien Gross
|
Sébastien Gross
|
||||||
Thomas Luzat
|
Thomas Luzat
|
||||||
Tomas Cernaj
|
Tomas Cernaj
|
||||||
Uroš Golja
|
Uroš Golja
|
||||||
con-f-use
|
con-f-use
|
||||||
Brayden Banks
|
|
||||||
japm48
|
japm48
|
||||||
|
Brayden Banks
|
||||||
|
jonasc
|
||||||
Daniel Wagenknecht
|
Daniel Wagenknecht
|
||||||
Franciszek Madej
|
Franciszek Madej
|
||||||
Mateusz Piotrowski
|
Mateusz Piotrowski
|
||||||
Paraplegic Racehorse
|
Paraplegic Racehorse
|
||||||
Patrick Hof
|
Patrick Hof
|
||||||
|
Russ Allbery
|
||||||
Satoshi Ohki
|
Satoshi Ohki
|
||||||
Sheng Yang
|
Sheng Yang
|
||||||
|
|
|
@ -42,7 +42,7 @@ Features, usage, examples and installation instructions can be found on the
|
||||||
[master-badge]: https://img.shields.io/travis/TheLocehiliosan/yadm/master.svg?label=master
|
[master-badge]: https://img.shields.io/travis/TheLocehiliosan/yadm/master.svg?label=master
|
||||||
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
|
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
|
||||||
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
|
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
|
||||||
[obs-badge]: https://img.shields.io/badge/OBS-v2.3.0-blue
|
[obs-badge]: https://img.shields.io/badge/OBS-v2.4.0-blue
|
||||||
[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
|
[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
|
||||||
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
|
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
|
||||||
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases
|
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
# yadm - Yet Another Dotfiles Manager
|
# yadm - Yet Another Dotfiles Manager
|
||||||
# Copyright (C) 2015-2019 Tim Byrne and Martin Zuther
|
# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
# yadm - Yet Another Dotfiles Manager
|
# yadm - Yet Another Dotfiles Manager
|
||||||
# Copyright (C) 2015-2019 Tim Byrne and Martin Zuther
|
# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
# yadm - Yet Another Dotfiles Manager
|
# yadm - Yet Another Dotfiles Manager
|
||||||
# Copyright (C) 2015-2019 Tim Byrne and Martin Zuther
|
# Copyright (C) 2015-2020 Tim Byrne and Martin Zuther
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
|
4
yadm
4
yadm
|
@ -1,6 +1,6 @@
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# yadm - Yet Another Dotfiles Manager
|
# yadm - Yet Another Dotfiles Manager
|
||||||
# Copyright (C) 2015-2019 Tim Byrne
|
# Copyright (C) 2015-2020 Tim Byrne
|
||||||
|
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
@ -20,7 +20,7 @@ if [ -z "$BASH_VERSION" ]; then
|
||||||
[ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
|
[ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
VERSION=2.3.0
|
VERSION=2.4.0
|
||||||
|
|
||||||
YADM_WORK="$HOME"
|
YADM_WORK="$HOME"
|
||||||
YADM_DIR=
|
YADM_DIR=
|
||||||
|
|
2
yadm.1
2
yadm.1
|
@ -1,5 +1,5 @@
|
||||||
.\" vim: set spell so=8:
|
.\" vim: set spell so=8:
|
||||||
.TH yadm 1 "17 December 2019" "2.3.0"
|
.TH yadm 1 "6 February 2020" "2.4.0"
|
||||||
|
|
||||||
.SH NAME
|
.SH NAME
|
||||||
|
|
||||||
|
|
193
yadm.md
193
yadm.md
|
@ -314,26 +314,27 @@
|
||||||
yadm.gpg-recipient
|
yadm.gpg-recipient
|
||||||
Asymmetrically encrypt files with a gpg public/private key pair.
|
Asymmetrically encrypt files with a gpg public/private key pair.
|
||||||
Provide a "key ID" to specify which public key to encrypt with.
|
Provide a "key ID" to specify which public key to encrypt with.
|
||||||
The key must exist in your public keyrings. If left blank or
|
The key must exist in your public keyrings. Multiple recipients
|
||||||
not provided, symmetric encryption is used instead. If set to
|
can be specified (separated by space). If left blank or not
|
||||||
"ASK", gpg will interactively ask for recipients. See the
|
provided, symmetric encryption is used instead. If set to
|
||||||
ENCRYPTION section for more details. This feature is disabled
|
"ASK", gpg will interactively ask for recipients. See the
|
||||||
|
ENCRYPTION section for more details. This feature is disabled
|
||||||
by default.
|
by default.
|
||||||
|
|
||||||
yadm.ssh-perms
|
yadm.ssh-perms
|
||||||
Disable the permission changes to $HOME/.ssh/*. This feature is
|
Disable the permission changes to $HOME/.ssh/*. This feature is
|
||||||
enabled by default.
|
enabled by default.
|
||||||
|
|
||||||
The following four "local" configurations are not stored in the
|
The following four "local" configurations are not stored in the
|
||||||
$HOME/.config/yadm/config, they are stored in the local repository.
|
$HOME/.config/yadm/config, they are stored in the local repository.
|
||||||
|
|
||||||
|
|
||||||
local.class
|
local.class
|
||||||
Specify a class for the purpose of symlinking alternate files.
|
Specify a class for the purpose of symlinking alternate files.
|
||||||
By default, no class will be matched.
|
By default, no class will be matched.
|
||||||
|
|
||||||
local.hostname
|
local.hostname
|
||||||
Override the hostname for the purpose of symlinking alternate
|
Override the hostname for the purpose of symlinking alternate
|
||||||
files.
|
files.
|
||||||
|
|
||||||
local.os
|
local.os
|
||||||
|
@ -348,9 +349,9 @@
|
||||||
to have an automated way of choosing an alternate version of a file for
|
to have an automated way of choosing an alternate version of a file for
|
||||||
a different operating system, host, user, etc.
|
a different operating system, host, user, etc.
|
||||||
|
|
||||||
yadm will automatically create a symbolic link to the appropriate ver-
|
yadm will automatically create a symbolic link to the appropriate ver-
|
||||||
sion of a file, when a valid suffix is appended to the filename. The
|
sion of a file, when a valid suffix is appended to the filename. The
|
||||||
suffix contains the conditions that must be met for that file to be
|
suffix contains the conditions that must be met for that file to be
|
||||||
used.
|
used.
|
||||||
|
|
||||||
The suffix begins with "##", followed by any number of conditions sepa-
|
The suffix begins with "##", followed by any number of conditions sepa-
|
||||||
|
@ -358,9 +359,9 @@
|
||||||
|
|
||||||
##<condition>[,<condition>,...]
|
##<condition>[,<condition>,...]
|
||||||
|
|
||||||
Each condition is an attribute/value pair, separated by a period. Some
|
Each condition is an attribute/value pair, separated by a period. Some
|
||||||
conditions do not require a "value", and in that case, the period and
|
conditions do not require a "value", and in that case, the period and
|
||||||
value can be omitted. Most attributes can be abbreviated as a single
|
value can be omitted. Most attributes can be abbreviated as a single
|
||||||
letter.
|
letter.
|
||||||
|
|
||||||
<attribute>[.<value>]
|
<attribute>[.<value>]
|
||||||
|
@ -370,25 +371,25 @@
|
||||||
|
|
||||||
|
|
||||||
template, t
|
template, t
|
||||||
Valid when the value matches a supported template processor.
|
Valid when the value matches a supported template processor.
|
||||||
See the TEMPLATES section for more details.
|
See the TEMPLATES section for more details.
|
||||||
|
|
||||||
user, u
|
user, u
|
||||||
Valid if the value matches the current user. Current user is
|
Valid if the value matches the current user. Current user is
|
||||||
calculated by running id -u -n.
|
calculated by running id -u -n.
|
||||||
|
|
||||||
distro, d
|
distro, d
|
||||||
Valid if the value matches the distro. Distro is calculated by
|
Valid if the value matches the distro. Distro is calculated by
|
||||||
running lsb_release -si or by inspecting the ID from /etc/os-
|
running lsb_release -si or by inspecting the ID from /etc/os-
|
||||||
release.
|
release.
|
||||||
|
|
||||||
os, o Valid if the value matches the OS. OS is calculated by running
|
os, o Valid if the value matches the OS. OS is calculated by running
|
||||||
uname -s.
|
uname -s.
|
||||||
|
|
||||||
class, c
|
class, c
|
||||||
Valid if the value matches the local.class configuration. Class
|
Valid if the value matches the local.class configuration. Class
|
||||||
must be manually set using yadm config local.class <class>. See
|
must be manually set using yadm config local.class <class>. See
|
||||||
the CONFIGURATION section for more details about setting
|
the CONFIGURATION section for more details about setting
|
||||||
local.class.
|
local.class.
|
||||||
|
|
||||||
hostname, h
|
hostname, h
|
||||||
|
@ -399,27 +400,27 @@
|
||||||
Valid when no other alternate is valid.
|
Valid when no other alternate is valid.
|
||||||
|
|
||||||
|
|
||||||
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
|
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
|
||||||
even though uname identifies as "Linux".
|
even though uname identifies as "Linux".
|
||||||
|
|
||||||
You may use any number of conditions, in any order. An alternate will
|
You may use any number of conditions, in any order. An alternate will
|
||||||
only be used if ALL conditions are valid. For all files managed by
|
only be used if ALL conditions are valid. For all files managed by
|
||||||
yadm's repository or listed in $HOME/.config/yadm/encrypt, if they
|
yadm's repository or listed in $HOME/.config/yadm/encrypt, if they
|
||||||
match this naming convention, symbolic links will be created for the
|
match this naming convention, symbolic links will be created for the
|
||||||
most appropriate version.
|
most appropriate version.
|
||||||
|
|
||||||
The "most appropriate" version is determined by calculating a score for
|
The "most appropriate" version is determined by calculating a score for
|
||||||
each version of a file. A template is always scored higher than any
|
each version of a file. A template is always scored higher than any
|
||||||
symlink condition. The number of conditions is the next largest factor
|
symlink condition. The number of conditions is the next largest factor
|
||||||
in scoring. Files with more conditions will always be favored. Any
|
in scoring. Files with more conditions will always be favored. Any
|
||||||
invalid condition will disqualify that file completely.
|
invalid condition will disqualify that file completely.
|
||||||
|
|
||||||
If you don't care to have all versions of alternates stored in the same
|
If you don't care to have all versions of alternates stored in the same
|
||||||
directory as the generated symlink, you can place them in the
|
directory as the generated symlink, you can place them in the
|
||||||
$HOME/.config/yadm/alt directory. The generated symlink or processed
|
$HOME/.config/yadm/alt directory. The generated symlink or processed
|
||||||
template will be created using the same relative path.
|
template will be created using the same relative path.
|
||||||
|
|
||||||
Alternate linking may best be demonstrated by example. Assume the fol-
|
Alternate linking may best be demonstrated by example. Assume the fol-
|
||||||
lowing files are managed by yadm's repository:
|
lowing files are managed by yadm's repository:
|
||||||
|
|
||||||
- $HOME/path/example.txt##default
|
- $HOME/path/example.txt##default
|
||||||
|
@ -442,7 +443,7 @@
|
||||||
|
|
||||||
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin
|
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin
|
||||||
|
|
||||||
Since the hostname doesn't match any of the managed files, the more
|
Since the hostname doesn't match any of the managed files, the more
|
||||||
generic version is chosen.
|
generic version is chosen.
|
||||||
|
|
||||||
If running on a Linux server named "host4", the link will be:
|
If running on a Linux server named "host4", the link will be:
|
||||||
|
@ -457,57 +458,57 @@
|
||||||
|
|
||||||
$HOME/path/example.txt -> $HOME/path/example.txt##class.Work
|
$HOME/path/example.txt -> $HOME/path/example.txt##class.Work
|
||||||
|
|
||||||
If no "##default" version exists and no files have valid conditions,
|
If no "##default" version exists and no files have valid conditions,
|
||||||
then no link will be created.
|
then no link will be created.
|
||||||
|
|
||||||
Links are also created for directories named this way, as long as they
|
Links are also created for directories named this way, as long as they
|
||||||
have at least one yadm managed file within them.
|
have at least one yadm managed file within them.
|
||||||
|
|
||||||
yadm will automatically create these links by default. This can be dis-
|
yadm will automatically create these links by default. This can be dis-
|
||||||
abled using the yadm.auto-alt configuration. Even if disabled, links
|
abled using the yadm.auto-alt configuration. Even if disabled, links
|
||||||
can be manually created by running yadm alt.
|
can be manually created by running yadm alt.
|
||||||
|
|
||||||
Class is a special value which is stored locally on each host (inside
|
Class is a special value which is stored locally on each host (inside
|
||||||
the local repository). To use alternate symlinks using class, you must
|
the local repository). To use alternate symlinks using class, you must
|
||||||
set the value of class using the configuration local.class. This is
|
set the value of class using the configuration local.class. This is
|
||||||
set like any other yadm configuration with the yadm config command. The
|
set like any other yadm configuration with the yadm config command. The
|
||||||
following sets the class to be "Work".
|
following sets the class to be "Work".
|
||||||
|
|
||||||
yadm config local.class Work
|
yadm config local.class Work
|
||||||
|
|
||||||
Similarly, the values of os, hostname, and user can be manually over-
|
Similarly, the values of os, hostname, and user can be manually over-
|
||||||
ridden using the configuration options local.os, local.hostname, and
|
ridden using the configuration options local.os, local.hostname, and
|
||||||
local.user.
|
local.user.
|
||||||
|
|
||||||
|
|
||||||
## TEMPLATES
|
## TEMPLATES
|
||||||
If a template condition is defined in an alternate file's "##" suffix,
|
If a template condition is defined in an alternate file's "##" suffix,
|
||||||
and the necessary dependencies for the template are available, then the
|
and the necessary dependencies for the template are available, then the
|
||||||
file will be processed to create or overwrite files.
|
file will be processed to create or overwrite files.
|
||||||
|
|
||||||
Supported template processors:
|
Supported template processors:
|
||||||
|
|
||||||
default
|
default
|
||||||
This is yadm's built-in template processor. This processor is
|
This is yadm's built-in template processor. This processor is
|
||||||
very basic, with a Jinja-like syntax. The advantage of this pro-
|
very basic, with a Jinja-like syntax. The advantage of this pro-
|
||||||
cessor is that it only depends upon awk, which is available on
|
cessor is that it only depends upon awk, which is available on
|
||||||
most *nix systems. To use this processor, specify the value of
|
most *nix systems. To use this processor, specify the value of
|
||||||
"default" or just leave the value off (e.g. "##template").
|
"default" or just leave the value off (e.g. "##template").
|
||||||
|
|
||||||
j2cli To use the j2cli Jinja template processor, specify the value of
|
j2cli To use the j2cli Jinja template processor, specify the value of
|
||||||
"j2" or "j2cli".
|
"j2" or "j2cli".
|
||||||
|
|
||||||
envtpl To use the envtpl Jinja template processor, specify the value of
|
envtpl To use the envtpl Jinja template processor, specify the value of
|
||||||
"j2" or "envtpl".
|
"j2" or "envtpl".
|
||||||
|
|
||||||
|
|
||||||
NOTE: Specifying "j2" as the processor will attempt to use j2cli or
|
NOTE: Specifying "j2" as the processor will attempt to use j2cli or
|
||||||
envtpl, whichever is available.
|
envtpl, whichever is available.
|
||||||
|
|
||||||
If the template processor specified is available, templates will be
|
If the template processor specified is available, templates will be
|
||||||
processed to create or overwrite files.
|
processed to create or overwrite files.
|
||||||
|
|
||||||
During processing, the following variables are available in the tem-
|
During processing, the following variables are available in the tem-
|
||||||
plate:
|
plate:
|
||||||
|
|
||||||
Default Jinja Description
|
Default Jinja Description
|
||||||
|
@ -519,10 +520,10 @@
|
||||||
yadm.user YADM_USER id -u -n
|
yadm.user YADM_USER id -u -n
|
||||||
yadm.source YADM_SOURCE Template filename
|
yadm.source YADM_SOURCE Template filename
|
||||||
|
|
||||||
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
|
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
|
||||||
even though uname identifies as "Linux".
|
even though uname identifies as "Linux".
|
||||||
|
|
||||||
NOTE: If lsb_release is not available, DISTRO will be the ID specified
|
NOTE: If lsb_release is not available, DISTRO will be the ID specified
|
||||||
in /etc/os-release.
|
in /etc/os-release.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
@ -535,7 +536,7 @@
|
||||||
config=dev-whatever
|
config=dev-whatever
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
would output a file named whatever with the following content if the
|
would output a file named whatever with the following content if the
|
||||||
user is "harvey":
|
user is "harvey":
|
||||||
|
|
||||||
config=work-Linux
|
config=work-Linux
|
||||||
|
@ -544,7 +545,7 @@
|
||||||
|
|
||||||
config=dev-whatever
|
config=dev-whatever
|
||||||
|
|
||||||
An equivalent Jinja template named whatever##template.j2 would look
|
An equivalent Jinja template named whatever##template.j2 would look
|
||||||
like:
|
like:
|
||||||
|
|
||||||
{% if YADM_USER == 'harvey' -%}
|
{% if YADM_USER == 'harvey' -%}
|
||||||
|
@ -555,62 +556,62 @@
|
||||||
|
|
||||||
|
|
||||||
## ENCRYPTION
|
## ENCRYPTION
|
||||||
It can be useful to manage confidential files, like SSH or GPG keys,
|
It can be useful to manage confidential files, like SSH or GPG keys,
|
||||||
across multiple systems. However, doing so would put plain text data
|
across multiple systems. However, doing so would put plain text data
|
||||||
into a Git repository, which often resides on a public system. yadm can
|
into a Git repository, which often resides on a public system. yadm can
|
||||||
make it easy to encrypt and decrypt a set of files so the encrypted
|
make it easy to encrypt and decrypt a set of files so the encrypted
|
||||||
version can be maintained in the Git repository. This feature will
|
version can be maintained in the Git repository. This feature will
|
||||||
only work if the gpg(1) command is available.
|
only work if the gpg(1) command is available.
|
||||||
|
|
||||||
To use this feature, a list of patterns must be created and saved as
|
To use this feature, a list of patterns must be created and saved as
|
||||||
$HOME/.config/yadm/encrypt. This list of patterns should be relative
|
$HOME/.config/yadm/encrypt. This list of patterns should be relative
|
||||||
to the configured work-tree (usually $HOME). For example:
|
to the configured work-tree (usually $HOME). For example:
|
||||||
|
|
||||||
.ssh/*.key
|
.ssh/*.key
|
||||||
.gnupg/*.gpg
|
.gnupg/*.gpg
|
||||||
|
|
||||||
Standard filename expansions (*, ?, [) are supported. If you have Bash
|
Standard filename expansions (*, ?, [) are supported. If you have Bash
|
||||||
version 4, you may use "**" to match all subdirectories. Other shell
|
version 4, you may use "**" to match all subdirectories. Other shell
|
||||||
expansions like brace and tilde are not supported. Spaces in paths are
|
expansions like brace and tilde are not supported. Spaces in paths are
|
||||||
supported, and should not be quoted. If a directory is specified, its
|
supported, and should not be quoted. If a directory is specified, its
|
||||||
contents will be included, but not recursively. Paths beginning with a
|
contents will be included, but not recursively. Paths beginning with a
|
||||||
"!" will be excluded.
|
"!" will be excluded.
|
||||||
|
|
||||||
The yadm encrypt command will find all files matching the patterns, and
|
The yadm encrypt command will find all files matching the patterns, and
|
||||||
prompt for a password. Once a password has confirmed, the matching
|
prompt for a password. Once a password has confirmed, the matching
|
||||||
files will be encrypted and saved as $HOME/.config/yadm/files.gpg. The
|
files will be encrypted and saved as $HOME/.config/yadm/files.gpg. The
|
||||||
patterns and files.gpg should be added to the yadm repository so they
|
patterns and files.gpg should be added to the yadm repository so they
|
||||||
are available across multiple systems.
|
are available across multiple systems.
|
||||||
|
|
||||||
To decrypt these files later, or on another system run yadm decrypt and
|
To decrypt these files later, or on another system run yadm decrypt and
|
||||||
provide the correct password. After files are decrypted, permissions
|
provide the correct password. After files are decrypted, permissions
|
||||||
are automatically updated as described in the PERMISSIONS section.
|
are automatically updated as described in the PERMISSIONS section.
|
||||||
|
|
||||||
Symmetric encryption is used by default, but asymmetric encryption may
|
Symmetric encryption is used by default, but asymmetric encryption may
|
||||||
be enabled using the yadm.gpg-recipient configuration.
|
be enabled using the yadm.gpg-recipient configuration.
|
||||||
|
|
||||||
NOTE: It is recommended that you use a private repository when keeping
|
NOTE: It is recommended that you use a private repository when keeping
|
||||||
confidential files, even though they are encrypted.
|
confidential files, even though they are encrypted.
|
||||||
|
|
||||||
Patterns found in $HOME/.config/yadm/encrypt are automatically added to
|
Patterns found in $HOME/.config/yadm/encrypt are automatically added to
|
||||||
the repository's info/exclude file every time yadm encrypt is run.
|
the repository's info/exclude file every time yadm encrypt is run.
|
||||||
This is to prevent accidentally committing sensitive data to the repos-
|
This is to prevent accidentally committing sensitive data to the repos-
|
||||||
itory. This can be disabled using the yadm.auto-exclude configuration.
|
itory. This can be disabled using the yadm.auto-exclude configuration.
|
||||||
|
|
||||||
Using git-crypt
|
Using git-crypt
|
||||||
|
|
||||||
A completely separate option for encrypting data is to install and use
|
A completely separate option for encrypting data is to install and use
|
||||||
git-crypt. Once installed, you can run git-crypt commands for the yadm
|
git-crypt. Once installed, you can run git-crypt commands for the yadm
|
||||||
repo by running yadm git-crypt. git-crypt enables transparent encryp-
|
repo by running yadm git-crypt. git-crypt enables transparent encryp-
|
||||||
tion and decryption of files in a git repository. You can read
|
tion and decryption of files in a git repository. You can read
|
||||||
https://github.com/AGWA/git-crypt for details.
|
https://github.com/AGWA/git-crypt for details.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## PERMISSIONS
|
## PERMISSIONS
|
||||||
When files are checked out of a Git repository, their initial permis-
|
When files are checked out of a Git repository, their initial permis-
|
||||||
sions are dependent upon the user's umask. Because of this, yadm will
|
sions are dependent upon the user's umask. Because of this, yadm will
|
||||||
automatically update the permissions of some file paths. The "group"
|
automatically update the permissions of some file paths. The "group"
|
||||||
and "others" permissions will be removed from the following files:
|
and "others" permissions will be removed from the following files:
|
||||||
|
|
||||||
- $HOME/.config/yadm/files.gpg
|
- $HOME/.config/yadm/files.gpg
|
||||||
|
@ -622,39 +623,39 @@
|
||||||
- The GPG directory and files, .gnupg/*
|
- The GPG directory and files, .gnupg/*
|
||||||
|
|
||||||
yadm will automatically update permissions by default. This can be dis-
|
yadm will automatically update permissions by default. This can be dis-
|
||||||
abled using the yadm.auto-perms configuration. Even if disabled, per-
|
abled using the yadm.auto-perms configuration. Even if disabled, per-
|
||||||
missions can be manually updated by running yadm perms. The .ssh
|
missions can be manually updated by running yadm perms. The .ssh
|
||||||
directory processing can be disabled using the yadm.ssh-perms configu-
|
directory processing can be disabled using the yadm.ssh-perms configu-
|
||||||
ration. The .gnupg directory processing can be disabled using the
|
ration. The .gnupg directory processing can be disabled using the
|
||||||
yadm.gpg-perms configuration.
|
yadm.gpg-perms configuration.
|
||||||
|
|
||||||
When cloning a repo which includes data in a .ssh or .gnupg directory,
|
When cloning a repo which includes data in a .ssh or .gnupg directory,
|
||||||
if those directories do not exist at the time of cloning, yadm will
|
if those directories do not exist at the time of cloning, yadm will
|
||||||
create the directories with mask 0700 prior to merging the fetched data
|
create the directories with mask 0700 prior to merging the fetched data
|
||||||
into the work-tree.
|
into the work-tree.
|
||||||
|
|
||||||
When running a Git command and .ssh or .gnupg directories do not exist,
|
When running a Git command and .ssh or .gnupg directories do not exist,
|
||||||
yadm will create those directories with mask 0700 prior to running the
|
yadm will create those directories with mask 0700 prior to running the
|
||||||
Git command. This can be disabled using the yadm.auto-private-dirs con-
|
Git command. This can be disabled using the yadm.auto-private-dirs con-
|
||||||
figuration.
|
figuration.
|
||||||
|
|
||||||
|
|
||||||
## HOOKS
|
## HOOKS
|
||||||
For every command yadm supports, a program can be provided to run
|
For every command yadm supports, a program can be provided to run
|
||||||
before or after that command. These are referred to as "hooks". yadm
|
before or after that command. These are referred to as "hooks". yadm
|
||||||
looks for hooks in the directory $HOME/.config/yadm/hooks. Each hook
|
looks for hooks in the directory $HOME/.config/yadm/hooks. Each hook
|
||||||
is named using a prefix of pre_ or post_, followed by the command which
|
is named using a prefix of pre_ or post_, followed by the command which
|
||||||
should trigger the hook. For example, to create a hook which is run
|
should trigger the hook. For example, to create a hook which is run
|
||||||
after every yadm pull command, create a hook named post_pull. Hooks
|
after every yadm pull command, create a hook named post_pull. Hooks
|
||||||
must have the executable file permission set.
|
must have the executable file permission set.
|
||||||
|
|
||||||
If a pre_ hook is defined, and the hook terminates with a non-zero exit
|
If a pre_ hook is defined, and the hook terminates with a non-zero exit
|
||||||
status, yadm will refuse to run the yadm command. For example, if a
|
status, yadm will refuse to run the yadm command. For example, if a
|
||||||
pre_commit hook is defined, but that command ends with a non-zero exit
|
pre_commit hook is defined, but that command ends with a non-zero exit
|
||||||
status, the yadm commit will never be run. This allows one to "short-
|
status, the yadm commit will never be run. This allows one to "short-
|
||||||
circuit" any operation using a pre_ hook.
|
circuit" any operation using a pre_ hook.
|
||||||
|
|
||||||
Hooks have the following environment variables available to them at
|
Hooks have the following environment variables available to them at
|
||||||
runtime:
|
runtime:
|
||||||
|
|
||||||
YADM_HOOK_COMMAND
|
YADM_HOOK_COMMAND
|
||||||
|
@ -664,7 +665,9 @@
|
||||||
The exit status of the yadm command
|
The exit status of the yadm command
|
||||||
|
|
||||||
YADM_HOOK_FULL_COMMAND
|
YADM_HOOK_FULL_COMMAND
|
||||||
The yadm command with all command line arguments
|
The yadm command with all command line arguments (parameters are
|
||||||
|
space delimited, and any space, tab or backslash will be escaped
|
||||||
|
with a backslash)
|
||||||
|
|
||||||
YADM_HOOK_REPO
|
YADM_HOOK_REPO
|
||||||
The path to the yadm repository
|
The path to the yadm repository
|
||||||
|
@ -674,13 +677,13 @@
|
||||||
|
|
||||||
|
|
||||||
## FILES
|
## FILES
|
||||||
All of yadm's configurations are relative to the "yadm directory".
|
All of yadm's configurations are relative to the "yadm directory".
|
||||||
yadm uses the "XDG Base Directory Specification" to determine this
|
yadm uses the "XDG Base Directory Specification" to determine this
|
||||||
directory. If the environment variable $XDG_CONFIG_HOME is defined as
|
directory. If the environment variable $XDG_CONFIG_HOME is defined as
|
||||||
a fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm.
|
a fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm.
|
||||||
Otherwise it will be $HOME/.config/yadm.
|
Otherwise it will be $HOME/.config/yadm.
|
||||||
|
|
||||||
The following are the default paths yadm uses for its own data. Most
|
The following are the default paths yadm uses for its own data. Most
|
||||||
of these paths can be altered using universal options. See the OPTIONS
|
of these paths can be altered using universal options. See the OPTIONS
|
||||||
section for details.
|
section for details.
|
||||||
|
|
||||||
|
@ -692,9 +695,9 @@
|
||||||
Configuration file for yadm.
|
Configuration file for yadm.
|
||||||
|
|
||||||
$YADM_DIR/alt
|
$YADM_DIR/alt
|
||||||
This is a directory to keep "alternate files" without having
|
This is a directory to keep "alternate files" without having
|
||||||
them side-by-side with the resulting symlink or processed tem-
|
them side-by-side with the resulting symlink or processed tem-
|
||||||
plate. Alternate files placed in this directory will be created
|
plate. Alternate files placed in this directory will be created
|
||||||
relative to $HOME instead.
|
relative to $HOME instead.
|
||||||
|
|
||||||
$YADM_DIR/repo.git
|
$YADM_DIR/repo.git
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
%{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
|
%{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
|
||||||
Name: yadm
|
Name: yadm
|
||||||
Summary: Yet Another Dotfiles Manager
|
Summary: Yet Another Dotfiles Manager
|
||||||
Version: 2.3.0
|
Version: 2.4.0
|
||||||
Group: Development/Tools
|
Group: Development/Tools
|
||||||
Release: 1%{?dist}
|
Release: 1%{?dist}
|
||||||
URL: https://yadm.io
|
URL: https://yadm.io
|
||||||
|
|
Loading…
Reference in a new issue