etckeeper

https://etckeeper.branchable.com/
Admin
etckeeper is a collection of tools that stores /etc in a version control repository (git, mercurial,...
Tokens:117,588
Snippets:1,202
Trust Score:8.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install and Initialize Etckeeper with Git

Source: https://etckeeper.branchable.com/forum/index.atom

Steps to install etckeeper, initialize a git repository in /etc, and set up a remote origin. This is a common setup for managing /etc with git.

```bash
apt install etckeeper
cd /etc/
git status
git diff
git commit -m "initial commit"
git gc
git remote add origin http://git.server/user/server_etc.git
```

```bash
git branch -m host-one
git push --set-upstream origin host-one
```

--------------------------------

### Example Process Tree with apt-get Install

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name

This process tree demonstrates the execution flow when etckeeper's post-install script is invoked during an 'apt-get install' operation on Debian. It highlights the involvement of 'sh -c' and the etckeeper scripts within the apt-get process.

```text
 400678 pts/18   S+     0:01  |                   \_ apt-get remove --purge docbook-xsl libxml2-utils
 400894 pts/18   S+     0:00  |                       \_ apt-get remove --purge docbook-xsl libxml2-utils
 400895 pts/18   S+     0:00  |                           \_ sh -c -- if [ -x /usr/bin/etckeeper ]; then etckeeper post-install; fi
 400896 pts/18   S+     0:00  |                               \_ /bin/sh /usr/bin/etckeeper post-install
 400901 pts/18   S+     0:00  |                                   \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit

```

--------------------------------

### Example of apt-get install command

Source: https://etckeeper.branchable.com/forum/index.atom

This command installs the apt-transport-https package, which is required for APT to handle packages over HTTPS connections.

```bash
apt-get install apt-transport-https
```

--------------------------------

### Install etckeeper

Source: https://etckeeper.branchable.com/README

Installs etckeeper using apt-get. This is the first step before using etckeeper.

```bash
apt-get install etckeeper

```

--------------------------------

### Build and Install etckeeper on LEDE

Source: https://etckeeper.branchable.com/todo/Porting_to_LEDE___40__OpenWRT__41___opkg/comments.rss

This snippet shows the output of attempting to build and install etckeeper on a LEDE system. It highlights missing dependencies like perl and bzrlib, as well as errors during the make install process.

```bash
root@LEDE:~/etckeeper.branchable.com# make
sed -i~ "s/Version:.&lt;em&gt;/Version: $(perl -e &#39;$_=&amp;lt;&amp;gt;;m/((.&lt;em&gt;?)(-.&lt;em&gt;)?)/;print $1;&#39;&amp;lt;debian/changelog)/" etckeeper.spec
/bin/sh: perl: not found
rm -f etckeeper.spec~
sed -i~ "s/Version:.&lt;/em&gt;/Version: $(perl -e &#39;$&lt;em&gt;=&amp;lt;&amp;gt;;m/((.&lt;em&gt;?)(-.&lt;/em&gt;)?)/;print $1;&#39; &amp;lt;debian/changelog)\"/" etckeeper
/bin/sh: perl: not found
rm -f etckeeper~
python ./etckeeper-bzr/&lt;strong&gt;init&lt;/strong&gt;.py build || echo "&lt;strong&gt; bzr support not built"
Traceback (most recent call last):
  File "./etckeeper-bzr/&lt;strong&gt;init&lt;/strong&gt;.py", line 6, in 
    from bzrlib.errors import BzrError
ImportError: No module named bzrlib.errors
&lt;/strong&gt; bzr support not built
python ./etckeeper-dnf/etckeeper.py build || echo "&lt;strong&gt; DNF support not built"
Traceback (most recent call last):
  File "./etckeeper-dnf/etckeeper.py", line 10, in 
    from dnfpluginscore import logger
ImportError: No module named dnfpluginscore
&lt;/strong&gt; DNF support not built
root@LEDE:~/etckeeper.branchable.com#
root@LEDE:~/etckeeper.branchable.com#
root@LEDE:~/etckeeper.branchable.com# make install
sed -i~ "s/Version:.*/Version: $(perl -e &#39;$&lt;/em&gt;=&amp;lt;&amp;gt;;m/((.&lt;em&gt;?)(-.&lt;/em&gt;)?)/;print $1;&#39; &amp;lt;debian/changelog)\"/" etckeeper
/bin/sh: perl: not found
rm -f etckeeper~
mkdir -p /etc/etckeeper/ /var/cache/etckeeper/
cp -R &lt;em&gt;.d /etc/etckeeper/
install  daily /etc/etckeeper/daily
make: install: Command not found
make: &lt;/em&gt;** [Makefile:29: install] Error 127
root@LEDE:~/etckeeper.branchable.com#
```

--------------------------------

### Apt-get Process Tree Example

Source: https://etckeeper.branchable.com/recentchanges

Process tree structure observed when running etckeeper post-install via apt-get.

```text
	 400678 pts/18   S+     0:01  |                   \_ apt-get remove --purge docbook-xsl libxml2-utils
	 400894 pts/18   S+     0:00  |                       \_ apt-get remove --purge docbook-xsl libxml2-utils
	 400895 pts/18   S+     0:00  |                           \_ sh -c -- if [ -x /usr/bin/etckeeper ]; then etckeeper post-install; fi
	 400896 pts/18   S+     0:00  |                               \_ /bin/sh /usr/bin/etckeeper post-install
	 400901 pts/18   S+     0:00  |                                   \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

--------------------------------

### Process tree examples

Source: https://etckeeper.branchable.com/ikiwiki.cgi?do=goto&page=forum%2Fthe_default_commit_message_has_the_wrong_process_name

Displays various process tree structures observed during etckeeper post-install execution for different environments.

```text
 397908 pts/16   Ss     0:00  |           \_ sudo -H /bin/bash
 397909 pts/16   S      0:00  |               \_ /bin/bash
 399115 pts/16   S+     0:00  |                   \_ /bin/sh /usr/bin/etckeeper post-install
 399121 pts/16   S+     0:00  |                       \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

```text
 400678 pts/18   S+     0:01  |                   \_ apt-get remove --purge docbook-xsl libxml2-utils
 400894 pts/18   S+     0:00  |                       \_ apt-get remove --purge docbook-xsl libxml2-utils
 400895 pts/18   S+     0:00  |                           \_ sh -c -- if [ -x /usr/bin/etckeeper ]; then etckeeper post-install; fi
 400896 pts/18   S+     0:00  |                               \_ /bin/sh /usr/bin/etckeeper post-install
 400901 pts/18   S+     0:00  |                                   \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

```text
 131379 pts/2    SN     0:00      \_ /usr/bin/bash
 131967 pts/2    SN+    0:00          \_ pacman -R mc
 132102 pts/2    SN+    0:00              \_ /bin/sh /usr/bin/etckeeper post-install
 132106 pts/2    SN+    0:00                  \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

--------------------------------

### Install Package with apt

Source: https://etckeeper.branchable.com/forum/index.atom

Installs a package using apt. etckeeper might warn about uncommitted changes if a transaction is still open.

```bash
apt-get install sublime-text
```

--------------------------------

### Example touch command for setting mtime

Source: https://etckeeper.branchable.com/todo/include_mtime_into_metadata/comments.rss

This command demonstrates how to set the modification time of a file. It's used as an example for specifying a time to 'touch' a file when considering mtime storage.

```bash
maybe touch -d '1970-01-01 00:00Z' foo
```

--------------------------------

### Manual etckeeper post-install process tree

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name/comments.rss

Example of a process tree observed when running etckeeper post-install manually.

```text
 397908 pts/16   Ss     0:00  |           \_ sudo -H /bin/bash
 397909 pts/16   S      0:00  |               \_ /bin/bash
 399115 pts/16   S+     0:00  |                   \_ /bin/sh /usr/bin/etckeeper post-install
 399121 pts/16   S+     0:00  |                       \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

--------------------------------

### Execute etckeeper build and install commands

Source: https://etckeeper.branchable.com/todo/Porting_to_LEDE___40__OpenWRT__41___opkg

Attempt to build and install etckeeper on a LEDE system, showing failures due to missing Perl and Python interpreters.

```bash
make install
root@LEDE:~/etckeeper.branchable.com# make sed -i~ "s/Version:._/Version: $(perl -e '$_= <>;m/((._?)(-._)?)/;print $1;' <debian/changelog)/" etckeeper.spec /bin/sh: perl: not found rm -f etckeeper.spec~ sed -i~ "s/Version:._/Version: $(perl -e '$_= <>;m/((._?)(-._)?)/;print $1;' <debian/changelog)"/" etckeeper /bin/sh: perl: not found rm -f etckeeper~ python ./etckeeper-bzr/**init**.py build || echo "**bzr support not built" Traceback (most recent call last): File "./etckeeper-bzr/**init**.py", line 6, in from bzrlib.errors import BzrError ImportError: No module named bzrlib.errors ** bzr support not built python ./etckeeper-dnf/etckeeper.py build || echo "**DNF support not built" Traceback (most recent call last): File "./etckeeper-dnf/etckeeper.py", line 10, in from dnfpluginscore import logger ImportError: No module named dnfpluginscore** DNF support not built root@LEDE:~/etckeeper.branchable.com# root@LEDE:~/etckeeper.branchable.com# root@LEDE:~/etckeeper.branchable.com# make install sed -i~ "s/Version:.*/Version: $(perl -e '$_=<>;m/((._?)(-._)?)/;print $1;' <debian/changelog)"/" etckeeper /bin/sh: perl: not found rm -f etckeeper~ mkdir -p /etc/etckeeper/ /var/cache/etckeeper/ cp -R _.d /etc/etckeeper/ install daily /etc/etckeeper/daily make: install: Command not found make:_ ** [Makefile:29: install] Error 127 root@LEDE:~/etckeeper.branchable.com#
```

--------------------------------

### Example of etckeeper managing ignored directories

Source: https://etckeeper.branchable.com/recentchanges

This example demonstrates how etckeeper manages empty directories that are ignored by git, showing the commands used and the output before and after a patch.

```bash
diff --git a/doc/todo/metadata_ignore_filters_do_not_work/comment_4_dc188a789e1b40158b14a88d7d088ee2._comment b/doc/todo/metadata_ignore_filters_do_not_work/comment_4_dc188a789e1b40158b14a88d7d088ee2._comment
new file mode 100644
index 0000000..c36f99b
--- /dev/null
+++ b/doc/todo/metadata_ignore_filters_do_not_work/comment_4_dc188a789e1b40158b14a88d7d088ee2._comment
@@ -0,0 +1,54 @@
+[[!comment format=mdwn
+ username="anarcat"
+ avatar="http://cdn.libravatar.org/avatar/1bb99a4f017a1d253ad5790c150d0f0b"
+ subject="some examples"
+ date="2022-11-23T16:32:38Z"
+ content="""
here's an example, from my workstation, which has a similar configuration to the server i was working on for this:

    root@curie:/etc# grep puppet/code/production .gitignore .etckeeper 
    .gitignore:puppet/code/production
    .etckeeper:mkdir -p './puppet/code/production'
    .etckeeper:maybe chown 'puppet' 'puppet/code/production'
    .etckeeper:maybe chgrp 'puppet' 'puppet/code/production'
    .etckeeper:maybe chmod 0750 'puppet/code/production'
    root@curie:/etc# ls -al puppet/code/production/
    total 18
    drwxr-x--- 2 puppet puppet 2 30 jun  2020 .
    drwxr-xr-x 3 root   root   3 30 jun  2020 ..

here you see the empty directory is managed in .etckeeper even though it's ignored.

i thought i provided clearer examples of this in the original article, but i guess it wasn't very explicit... here's an example:

right now, if i revert the changes I made to `etckeeper/pre-commit.d/30store-metadata`, and run the hook:

    VCS=git /etc/etckeeper/pre-commit.d/30store-metadata

... i get this:

    root@marcos:/etc# grep puppet/code/production .gitignore 
    puppet/code/production
    root@marcos:/etc# grep -c puppet/code/production .etckeeper 
    87

it's mostly empty directories, but there's also other stuff:

    root@marcos:/etc# grep puppet/code/production .etckeeper | head -3
    mkdir -p './puppet/code/production/.g10k/CraigWatson1987-transmission-2.2.1/spec/fixtures'
    mkdir -p './puppet/code/production/.g10k/duritong-sysctl-0.0.12/spec/fixtures/manifests'
    mkdir -p './puppet/code/production/.g10k/duritong-sysctl-0.0.12/spec/fixtures/modules/sysctl'
    root@marcos:/etc# grep puppet/code/production .etckeeper | tail -3
    mkdir -p './puppet/code/production/modules/inifile/locales/ja'
    maybe chown 'anarcat' 'puppet/code/production'
    maybe chmod 0755 'puppet/code/production'

with the patch, it looks like this instead:

    root@marcos:/etc# grep puppet/code/production .gitignore 
    puppet/code/production
    root@marcos:/etc# grep -c puppet/code/production .etckeeper 
    0

the patch proposed here, together with the one on [[todo/metadata_ignore_filters_do_not_work]] improve etckeeper performance tremendously in my case.
"""]]

```

--------------------------------

### Example .gitignore content

Source: https://etckeeper.branchable.com/todo/index.rss

This example shows typical .gitignore content, specifically excluding compiled Python files (.pyc) and bytecode files (.pyo). This is relevant for etckeeper's handling of ignored files.

```gitignore
# cat .gitignore | grep -i py
*.pyc
*.pyo
```

--------------------------------

### Pacman Process Tree Example

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name/comments.rss

This shows the process tree when using pacman, illustrating how etckeeper is invoked.

```bash
 131379 pts/2    SN     0:00      \_ /usr/bin/bash
 131967 pts/2    SN+    0:00          \_ pacman -R mc
 132102 pts/2    SN+    0:00              \_ /bin/sh /usr/bin/etckeeper post-install
 132106 pts/2    SN+    0:00                  \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit
```

--------------------------------

### Configure etckeeper hooks

Source: https://etckeeper.branchable.com/recentchanges/index.rss

Example configuration for etckeeper pre-install and post-transaction hooks using shell pipes.

```sh
+goal_resolved:::raise_error=1:/usr/bin/sh -o pipefail -c /usr/bin/etckeeper\ pre-install\ |\ /usr/bin/sed\ -e\ 's/^/log.INFO=/'
```

```sh
+post_transaction::::/usr/bin/sh -o pipefail -c ETCKEEPER_PPID=${pid}\ /usr/bin/etckeeper\ post-install\ |\ /usr/bin/sed\ -e\ 's/^/log.INFO=/'
```

--------------------------------

### Example of etckeeper configuration path

Source: https://etckeeper.branchable.com/todo/metadata_changes_don__39__t_cause_a_new_commit/comments.rss

This path `/etc/etckeeper/daily` is an example of a configuration file that might not trigger a commit due to etckeeper's handling of metadata changes.

```bash
/etc/etckeeper/daily
```

--------------------------------

### Example of apt-key add command

Source: https://etckeeper.branchable.com/forum/index.atom

This command is used to add a GPG key to the APT keyring, which is necessary for verifying package authenticity from a new repository.

```bash
wget ... | apt-key add -
```

--------------------------------

### etckeeper initialization behavior

Source: https://etckeeper.branchable.com/forum/etckeeper_uses_git_despite_VCS__61____34__hg__34___when_a___47__etc__47__.git_directory_exists

When etckeeper is installed via apt on Debian, it automatically runs 'etckeeper init'. By default, this sets up a Git-based repository. To use a different VCS like Mercurial, the /etc/etckeeper/etckeeper.conf file must be configured *before* installation.

```bash
# I noticed that (at least in Debian 11.2 bullseye) `apt install etckeeper` automatically runs `etckeeper init`, thereby setting up a **git** -based etckeeper according to the default `etckeeper.conf` file - but I want **hg**.
```

--------------------------------

### Example etckeeper vcs revert command

Source: https://etckeeper.branchable.com/todo/Pull_request%3A_Export_key_environment_variables_for_vcs_subcommand

This example shows how to use the 'etckeeper vcs revert' subcommand with a specific revision. It highlights the potential need for environment variables to be exported similarly to the 'commit' subcommand for full functionality.

```bash
sudo etckeeper vcs revert $REVISION
```

--------------------------------

### Initialize etckeeper repository

Source: https://etckeeper.branchable.com/README

Initializes a git repository in /etc/. This command is often run automatically during package installation.

```bash
etckeeper init

```

--------------------------------

### etckeeper Command Usage

Source: https://etckeeper.branchable.com/forum/index.atom

Examples of common etckeeper and git commands used for managing /etc configuration files.

```bash
etckeeper init
```

```bash
git commit
```

```bash
git status
```

```bash
etckeeper commit
```

```bash
etckeeper vcs status
```

--------------------------------

### Etckeeper Configuration Example

Source: https://etckeeper.branchable.com/ikiwiki.cgi?do=goto&page=todo%2Fclear_up_confusion_about_daily_autocommit_and_systemd%2Fcomment_6_60adf5bca32dc56161b31ab52b708fbc

This configuration snippet from etckeeper.conf explains the dual functionality of cron jobs and systemd timers for daily commits and how to enable the systemd timer.

```ini
# Etckeeper includes both a cron job and a systemd timer, which each
# can commit exiting changes to /etc automatically once per day.
# To enable the systemd timer, run: systemctl enable etckeeper.timer

```

--------------------------------

### Etckeeper Post-install Command

Source: https://etckeeper.branchable.com/ikiwiki.cgi?do=goto&page=forum%2FRFE%3A_please_add_support_for_DNF_5%2Fcomment_5_06891384ecf5262959130ccf60b75eb1

This command is executed after installation, capturing the parent process ID for etckeeper's post-install hook and logging.

```sh
post_transaction::::/usr/bin/sh -o pipefail -c ETCKEEPER_PPID=${pid} /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO/'
```

--------------------------------

### Inline Code Example

Source: https://etckeeper.branchable.com/todo/Ignore___47__etc__47__.updated/comments.rss

This inline code snippet is mentioned in the context of unattended-upgrades failing due to an uncommitted /etc/.updated file.

```text
AVOID_COMMIT_BEFORE_INSTALL=1
```

--------------------------------

### Example of creating an APT sources list file

Source: https://etckeeper.branchable.com/forum/index.atom

This command creates a new file in the /etc/apt/sources.list.d/ directory, which is used to add new software repositories to APT's sources.

```bash
create  /etc/apt/sources.list.d/sublime-text.list
```

--------------------------------

### Update Etckeeper Installation Path in Spec File

Source: https://etckeeper.branchable.com/recentchanges/index.rss

This change in the etckeeper.spec file modifies the installation command for the cron.daily script. It ensures the script is installed from the correct source path.

```shell
install -D cron.daily $RPM_BUILD_ROOT/etc/cron.daily/etckeeper
```

--------------------------------

### Initialize and Rebase Git Repository

Source: https://etckeeper.branchable.com/forum/Comparing___47__etcs/comments.rss

Use these commands to set up a temporary directory, initialize a Git repository, and rebase against a remote branch.

```bash
#use a temp dir
mkdir /tmp/etc
cd /tmp/etc
git init
git remote add origin http://git.server/user/server_etc.git
touch init
git add .
git commit -m "init"
git push --set-upstream origin master
git fetch
git checkout host-one
git rebase master
#lots of merge errors due to master being empty repo
git add .
git rebase --continue
git push --force #as local is now "ahead" of remote.
```

--------------------------------

### Update Makefile for cron.daily installation

Source: https://etckeeper.branchable.com/recentchanges

Adds instructions to the Makefile to install the cron.daily script on Debian-based systems.

```makefile
+	mkdir -p $(DESTDIR)$(etcdir)/cron.daily
+	$(INSTALL_EXE) cron.daily $(DESTDIR)$(etcdir)/cron.daily/etckeeper
```

--------------------------------

### Check etckeeper version

Source: https://etckeeper.branchable.com/forum/etckeeper_uses_git_despite_VCS__61____34__hg__34___when_a___47__etc__47__.git_directory_exists

Displays the installed version of etckeeper. This is useful for verifying the installation and checking compatibility.

```bash
etckeeper version:
  * `etckeeper/stable,stable,now 1.18.16-1 all [residual-config]`
```

--------------------------------

### DNF 5 Transaction Output Example

Source: https://etckeeper.branchable.com/forum/RFE%3A_please_add_support_for_DNF_5/comments.rss

Example output from a dnf update command when etckeeper detects uncommitted changes.

```text
# dnf update neovim

** etckeeper detected uncommitted changes in /etc prior to dnf run
** Aborting dnf run. Manually commit and restart.

File "/etc/dnf/libdnf5-plugins/actions.d/etckeeper.actions" on line 3: Exit code: 1
```

--------------------------------

### Initialize Git for $HOME/.config

Source: https://etckeeper.branchable.com/forum/Additionally_keeping_configuration_in_a_home_directory_in_the_same_git_repo_as___47__etc___63__/comments.rss

Use this command sequence to initialize a Git repository in your $HOME/.config directory for version control. Ensure you are in the target directory before running.

```bash
cd $HOME/.config
git init
git add -A
git commit -m "Configuration import"
```

--------------------------------

### Update etckeeper spec file installation path

Source: https://etckeeper.branchable.com/recentchanges

Modifies the installation path for the cron.daily script within the RPM spec file.

```diff
diff --git a/etckeeper.spec b/etckeeper.spec
index e67e10c..f5348ba 100644
--- a/etckeeper.spec
+++ b/etckeeper.spec
@@ -36,7 +36,7 @@ make %{?_smp_mflags}
 %install
 rm -rf $RPM_BUILD_ROOT
 make install DESTDIR=$RPM_BUILD_ROOT
-install -D debian/cron.daily $RPM_BUILD_ROOT/etc/cron.daily/etckeeper
+install -D cron.daily $RPM_BUILD_ROOT/etc/cron.daily/etckeeper
 
 
 %clean
```

--------------------------------

### Example Process Tree with Manual etckeeper Post-Install

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name

This process tree illustrates the execution flow when etckeeper's post-install script is run manually via bash and sudo. It shows the parent-child relationships between the shell processes involved.

```text
 397908 pts/16   Ss     0:00  |           \_ sudo -H /bin/bash
 397909 pts/16   S      0:00  |               \_ /bin/bash
 399115 pts/16   S+     0:00  |                   \_ /bin/sh /usr/bin/etckeeper post-install
 399121 pts/16   S+     0:00  |                       \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit

```

--------------------------------

### Etckeeper Diff Output Example

Source: https://etckeeper.branchable.com/recentchanges/index.rss

This is an example of the diff output generated by etckeeper, showing changes to a file. It is presented in a standard diff format.

```diff
diff --git a/doc/forum/Additionally_keeping_configuration_in_a_home_directory_in_the_same_git_repo_as___47__etc___63__/comment_1_71dde3806cae33b0878e2d1a66b53990._comment b/doc/forum/Additionally_keeping_configuration_in_a_home_directory_in_the_same_git_repo_as___47__etc___63__/comment_1_71dde3806cae33b0878e2d1a66b53990._comment
new file mode 100644
index 0000000..404c9fa
--- /dev/null
+++ b/doc/forum/Additionally_keeping_configuration_in_a_home_directory_in_the_same_git_repo_as___47__etc___63__/comment_1_71dde3806cae33b0878e2d1a66b53990._comment
@@ -0,0 +1,35 @@
+&amp;#91;&amp;#91;!comment format=mdwn
+ username=&amp;quot;ferdnyc&amp;quot;
+ avatar=&amp;quot;http://cdn.libravatar.org/avatar/0a1d7aeb5a21edb0fcce12df464ff13b&amp;quot;
+ subject=&amp;quot;comment 1&amp;quot;
+ date=&amp;quot;2026-03-24T12:35:45Z&amp;quot;
+ content=&amp;quot;&amp;quot;&amp;quot;
+I&amp;#39;m not a developer here, but as a longterm user of etckeeper... I don&amp;#39;t think that would be a very good idea, personally.
+
+The thing is that etckeeper&amp;#39;s value isn&amp;#39;t **just** about automatically managing a bunch of files in a VCS. There are lots of things that can do that. What etckeeper brings to the table are the things that also make it specific to a system&amp;#39;s `/etc` directory. Things like:
+
+* Its understanding of how to manage permissions on files and directories in `/etc`, above and beyond what VCS systems natively track, so that the repository managed by the VCS is usable as a historical record of the system configuration, and older states can be restored without corrupting the system configuration.
+
+* Its integration with the system package management, with automatic monitoring of package transactions and automated commits when changes are made by package tools.
+
+None of that really applies to configuration anywhere else, and most of it actively works _against_ any other type of configuration management.
+
+1. Configuration in a user&amp;#39;s home directory isn&amp;#39;t going to be altered by package transactions, and the package-transaction scripts in `/etc/etckeeper/` would likely get thrown off by user-configuration files being part of the repo, when attempting to automatically track changes.
+
+2. Configuration in a user&amp;#39;s home directory isn&amp;#39;t going to need special management of ownership and permissions. All of the files will be owned by the user and edited only by that user.
+
+3. Configuration in a user&amp;#39;s home directory almost certainly shouldn&amp;#39;t be mixed with system configuration in `/etc`, even on a single-user personal machine where the user in question is solely in charge of both their account configuration and the systemwide configuration. They&amp;#39;re just different problem domains that don&amp;#39;t lend themselves to a combined solution.
+
+If you just want to keep your `$HOME/.config/` in version control, great idea! I do the same thing. But you don&amp;#39;t need (and I would argue, don&amp;#39;t _want_) etckeeper to do that. All you need is this:
+
+```bash
+cd $HOME/.config
git init
git add -A
git commit -m &amp;quot;Configuration import&amp;quot;
```
+
+And then, if you don&amp;#39;t think you&amp;#39;ll remember to commit changes frequently enough, maybe set up a cron job or systemd `.timer` user unit to run `git commit -a -m &amp;quot;Periodic commit for $(date)` or `git add -A; git commit -m &amp;quot;Periodic commit for $(date)\
&quot;` in that directory on a regular basis. (`git commit -a` is safer but only updates or deletes already-tracked files, it won&amp;#39;t pick up newly-added ones. `git add -A` is more comprehensive, but runs the danger of accidentally grabbing files you don&amp;#39;t want to commit &amp;mdash; though that can be mitigated somewhat by building a really comprehensive `.gitignore` file for the directory.)
+
+But most of etckeeper&amp;#39;s features would be working _against_ you, in attempting to have it manage a `$HOME/.config/` space.
+&amp;quot;&amp;quot;&amp;quot;&amp;#93;&amp;#93;
```

--------------------------------

### Git Initialization for Home Directory Configuration

Source: https://etckeeper.branchable.com/recentchanges/index.rss

This snippet demonstrates how to initialize a Git repository for managing configuration files in a user's home directory, such as $HOME/.config. It is a manual approach and does not require etckeeper.

```bash
cd $HOME/.config
git init
git add -A
git commit -m &quot;Configuration import&quot;
```

--------------------------------

### Initialize a git repository

Source: https://etckeeper.branchable.com/forum/index.atom

Initializes a standard git repository in the root directory.

```bash
git init /
```

--------------------------------

### Example Process Tree with pacman -R

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name

This process tree shows the execution flow when etckeeper's post-install script is invoked during a 'pacman -R' operation. It illustrates the direct execution of pacman and subsequent etckeeper scripts.

```text
 131379 pts/2    SN     0:00      \_ /usr/bin/bash
 131967 pts/2    SN+    0:00          \_ pacman -R mc
 132102 pts/2    SN+    0:00              \_ /bin/sh /usr/bin/etckeeper post-install
 132106 pts/2    SN+    0:00                  \_ /bin/sh /etc/etckeeper/post-install.d/50vcs-commit

```

--------------------------------

### Example DNF 5 transaction hook output

Source: https://etckeeper.branchable.com/ikiwiki.cgi?do=goto&page=forum%2Fthe_default_commit_message_has_the_wrong_process_name%2Fcomment_5_99a49d21df94f585c5cac65563161367

An example of a commit message generated by DNF 5 transaction hooks, showing the complex command line structure.

```text
Author: (me)
Date:   Mon Mar 23 04:57:35 2026 -0400

    committing changes in /etc made by "/usr/bin/sh -c /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO=/'"

    Package changes:
    -0:Pencil2D-0.7.0-18.fc43.x86_64
    +0:Pencil2D-0.7.2-1.fc43.x86_64
    -0:btrfs-progs-6.17.1-1.fc43.x86_64
    -0:btrfs-progs-devel-6.17.1-1.fc43.x86_64
    +0:btrfs-progs-6.19.1-1.fc43.x86_64
    +0:btrfs-progs-devel-6.19.1-1.fc43.x86_64
    -0:forgejo-runner-5.0.4-1.fc42.x86_64
    +0:forgejo-runner-12.7.1-1.fc43.x86_64
    -0:gnome-control-center-49.5-1.fc43.x86_64
    -0:gnome-control-center-filesystem-49.5-1.fc43.noarch
```

--------------------------------

### Initialize Git Repository for User Configuration

Source: https://etckeeper.branchable.com/forum/Additionally_keeping_configuration_in_a_home_directory_in_the_same_git_repo_as___47__etc___63__

Use this command to initialize a Git repository in your user configuration directory. This is a standard approach for versioning personal configuration files.

```bash
cd $HOME/.config
git init
git add -A
git commit -m "Configuration import"

```

--------------------------------

### Initialize Etckeeper and Git Repository

Source: https://etckeeper.branchable.com/forum/Comparing___47__etcs

Installs etckeeper, checks Git status, diffs changes, makes an initial commit, and adds a remote origin. This is the first step in managing /etc with Git.

```bash
apt install etckeeper
cd /etc/
git status
git diff
git commit -m "initial commit"
git gc
git remote add origin http://git.server/user/server_etc.git
```

--------------------------------

### Git submodule configuration example

Source: https://etckeeper.branchable.com/forum/index.atom

This is an example of a .gitmodules file, which stores information about Git submodules, including their paths and URLs. This format is used to manage external repositories within a larger project.

```gitconfig
[submodule "path/to/dir"]
        path = path/to/dir
        url = https://...
```

--------------------------------

### Skip Git Commit Hook Installation in Git Worktree

Source: https://etckeeper.branchable.com/ikiwiki.cgi?do=goto&page=todo%2FPull_request%3A_check_for_git_worktree_before_trying_to_add_pre-commit_hook

This snippet prevents the installation of the git commit hook when etckeeper is initialized within a git worktree. It avoids errors related to nonexistent directories.

```bash
/etc/etckeeper/init.d/50vcs-pre-commit-hook: 11: cannot create .git/hooks/pre-commit: Directory nonexistent

```

--------------------------------

### Etckeeper Post-install Hook with Logging

Source: https://etckeeper.branchable.com/forum/RFE%3A_please_add_support_for_DNF_5/comments.rss

This snippet demonstrates etckeeper's post-install hook, setting the ETCKEEPER_PPID and logging information using sed. This is useful for tracking etckeeper's execution context.

```sh
post_transaction::::/usr/bin/sh -o pipefail -c ETCKEEPER_PPID=${pid} /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO=/'
```

--------------------------------

### DNF 5 Commit Message Example

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name/comments.rss

This example shows a commit message generated by etckeeper when using DNF 5's transaction hooks, highlighting a verbose and less clear process identification.

```text
Author: (me)
Date:   Mon Mar 23 04:57:35 2026 -0400

    committing changes in /etc made by "/usr/bin/sh -c /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO=/'"

    Package changes:
    -0:Pencil2D-0.7.0-18.fc43.x86_64
    +0:Pencil2D-0.7.2-1.fc43.x86_64

```

--------------------------------

### Skip Git Commit Hook Installation in Git Worktrees

Source: https://etckeeper.branchable.com/todo/Pull_request%3A_check_for_git_worktree_before_trying_to_add_pre-commit_hook

This snippet prevents the etckeeper init command from attempting to install the git commit-hook when inside a git worktree. This avoids errors related to non-existent directories.

```bash
/etc/etckeeper/init.d/50vcs-pre-commit-hook: 11: cannot create .git/hooks/pre-commit: Directory nonexistent
```

--------------------------------

### Example Commit Message with DNF Transaction Hooks

Source: https://etckeeper.branchable.com/forum/the_default_commit_message_has_the_wrong_process_name

This is an example of a commit message generated by etckeeper when DNF 5 transaction hooks are in use. It highlights a complex command line that makes identifying the package manager difficult.

```git
Author: (me)
Date:   Mon Mar 23 04:57:35 2026 -0400

    committing changes in /etc made by "/usr/bin/sh -c /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO=/'"

    Package changes:
    -0:Pencil2D-0.7.0-18.fc43.x86_64
    +0:Pencil2D-0.7.2-1.fc43.x86_64
    -0:btrfs-progs-6.17.1-1.fc43.x86_64
    -0:btrfs-progs-devel-6.17.1-1.fc43.x86_64
    +0:btrfs-progs-6.19.1-1.fc43.x86_64
    +0:btrfs-progs-devel-6.19.1-1.fc43.x86_64
    -0:forgejo-runner-5.0.4-1.fc42.x86_64
    +0:forgejo-runner-12.7.1-1.fc43.x86_64
    -0:gnome-control-center-49.5-1.fc43.x86_64
    -0:gnome-control-center-filesystem-49.5-1.fc43.noarch


```

--------------------------------

### Avoid Installing Git Commit Hook in Worktree

Source: https://etckeeper.branchable.com/recentchanges/index.rss

This change modifies the etckeeper init command to check if it's running inside a git worktree. If so, it skips the installation of the git commit-hook to prevent errors like 'Directory nonexistent'.

```diff
diff --git a/doc/todo/Pull_request:_check_for_git_worktree_before_trying_to_add_pre-commit_hook.mdwn b/doc/todo/Pull_request:_check_for_git_worktree_before_trying_to_add_pre-commit_hook.mdwn
index 45ae880..6d81a62 100644
--- a/doc/todo/Pull_request:_check_for_git_worktree_before_trying_to_add_pre-commit_hook.mdwn
+++ b/doc/todo/Pull_request:_check_for_git_worktree_before_trying_to_add_pre-commit_hook.mdwn
@@ -1,5 +1,7 @@
-Please consider adding the change from this &amp;#91;pull request&amp;#93;(https://github.com/ktetzlaff/etckeeper-fork/tree/fix-init-in-worktree):
+Please consider adding the following commit from &amp;#91;this branch&amp;#93;(https://github.com/ktetzlaff/etckeeper-fork/tree/fix-init-in-worktree):
 
-The commit-hook itself already checks for git worktrees and skips any actions which would modify the .etckeeper file. This commit adds a similar check to the `etckeeper init` command which skips trying to install the git commit-hook itself when inside a git worktree. This avoids the following error message (from running `etckeeper init -d` inside a worktree to e.g. fix permissions):
+## Don&amp;#39;t try to add git-commit hook when in a git worktree
+ 
+The commit-hook itself already checks for git worktrees and skips any actions which would modify the `.etckeeper` file. This commit adds a similar check to the `etckeeper init` command which skips trying to install the git commit-hook itself when inside a git worktree. This avoids the following error message (from running `etckeeper init -d` inside a worktree to e.g. fix permissions):
 
     /etc/etckeeper/init.d/50vcs-pre-commit-hook: 11: cannot create .git/hooks/pre-commit: Directory nonexistent

```

--------------------------------

### Stage apt Source List with git

Source: https://etckeeper.branchable.com/forum/index.atom

Stages the newly created apt source list file using git. This action is part of tracking configuration changes with etckeeper.

```bash
git add      apt/sources.list.d/sublime-text.list
```

--------------------------------

### Configure global ignore pattern for Mercurial

Source: https://etckeeper.branchable.com/todo/index.rss

Example of a .hgignore configuration that ignores all files in the repository.

```text
syntax: glob
**
```

--------------------------------

### Etckeeper forum comment metadata

Source: https://etckeeper.branchable.com/recentchanges

Examples of comment file structures used in the etckeeper documentation forum.

```markdown
[[!comment format=mdwn
 username="pulk"
 avatar="http://cdn.libravatar.org/avatar/3aca97ac14e8c43b9da4a9070d45e443"
 subject="comment 6"
 date="2023-04-25T05:43:57Z"
 content="""
Thanks! That solved the issue. I did not remember that I had previously attempted to add it as submodule to workaround the issue.
"""]]
```

```markdown
[[!comment format=mdwn
 username="joey"
 subject="""comment 1"""
 date="2023-04-21T16:10:58Z"
 content="""
`etckeeper commit` is what the cron job runs. That does not run
`git gc`.

I don't think a git commit triggers a gc either, normmally.

Have you perhaps added a hook or something that causes the git gc?
"""]]
```

```markdown
[[!comment format=mdwn
 username="joey"
 subject="""comment 5"""
 date="2023-04-21T16:02:43Z"
 content="""
Your repo has already been added as a submodule. That's why git commit is
complaining about it.

If you put it in /etc/.gitignore before `etckeeper commit`,
it will be ignored from the beginning.

At this point you will need to remove the submodule as well as ignoring it.

I was a little surprised to see etckeeper adding git repos within /etc
as submodules, but it turns out that `git add --all` or `git add .` do add
submodules that way.
"""]]
```

--------------------------------

### Etckeeper Comment Format

Source: https://etckeeper.branchable.com/recentchanges

Example of the internal comment format used for storing forum posts in the wiki.

```text
[[!comment format=mdwn
 username="ferdnyc"
 avatar="http://cdn.libravatar.org/avatar/0a1d7aeb5a21edb0fcce12df464ff13b"
 subject="comment 5"
 date="2026-03-24T16:13:30Z"
 content="""
Actually, looking at Dam9k's message that started all of this, I guess the _default_ `ETCKEEPER_PARENT_LEVEL` would be `2`, not `1`. The DNF scripts would pass `-l 3` when they run `etckeeper`, and the `pacman` integration would use `-l 1`.
"""]]
```

```text
[[!comment format=mdwn
 username="ferdnyc"
 avatar="http://cdn.libravatar.org/avatar/0a1d7aeb5a21edb0fcce12df464ff13b"
 subject="DNF's action scripts make an even bigger mess of it"
 date="2026-03-24T16:04:46Z"
 content="""
This situation is arguably made even worse by the transaction-hooks implemented for DNF 5, which currently cause commit messages like this:

```text
Author: (me)
Date:   Mon Mar 23 04:57:35 2026 -0400

    committing changes in /etc made by \"/usr/bin/sh -c /usr/bin/etckeeper post-install | /usr/bin/sed -e 's/^/log.INFO=/'\"
    
    Package changes:
    -0:Pencil2D-0.7.0-18.fc43.x86_64
    +0:Pencil2D-0.7.2-1.fc43.x86_64
    -0:btrfs-progs-6.17.1-1.fc43.x86_64
    -0:btrfs-progs-devel-6.17.1-1.fc43.x86_64
    +0:btrfs-progs-6.19.1-1.fc43.x86_64
    +0:btrfs-progs-devel-6.19.1-1.fc43.x86_64
    -0:forgejo-runner-5.0.4-1.fc42.x86_64
    +0:forgejo-runner-12.7.1-1.fc43.x86_64
    -0:gnome-control-center-49.5-1.fc43.x86_64
    -0:gnome-control-center-filesystem-49.5-1.fc43.noarch
```

That nonsense command line is the one found in `/etc/dnf/libdnf5-plugins/actions.d/etckeeper.actions` where it's configured as a `post_transaction` hook. (Ignore the `sed` command it's piped into in order to convert the script's output into DNF 5 log messages. Awful design decision in libdnf5, at least IMHO. Why it wouldn't just log whatever the script dumps to stdout is beyond my comprehension.) Presumably you'd need to look at **its** parent, to discover that `dnf` is the package management tool in use.

But anyway, all of this is to say that I agree: the process discovery used in 50vcs-commit is too simplistic/limited to handle all of the scenarios etckeeper may find itself operating under.

It's stupid, but I wonder if something like a parent-level argument passed to etckeeper when a VCS runs commands might not be the most universal approach.

i.e. `etckeeper` itself gets logic similar to this, in its option parsing, to replace the simplistic \"-d\" handling that's currently there:

```bash
while [ \"x${1:0:1}\" = \"x-\" ]; do
  case \"$1\" in
  \"-d\")
    ETCKEEPER_DIR=\"$2\"
    shift 2
    ;;
  \"-l\")
    ETCKEEPER_PARENT_LEVEL=\"$2\"
    shift 2
    ;;
  \"--\")
    shift
    break
    ;;
  *)
    # Complain about an unknown option error
    ;;
  esac
done
```

(Or I suppose it could just use `getopt`/`getopts`, since it's gotten complex enough.)

Regardless, `ETCKEEPER_PARENT_LEVEL` is set to the numeric value that follows the `-l` flag, which would dictate how many levels up the process tree it should climb when looking for the relevant parent process. (The default would be `ETCKEEPER_PARENT_LEVEL=1`, IOW look for the direct parent of the etckeeper script invocation.)

The command in `libdnf5-plugins/actions.d/etckeeper.actions` could be changed to: 

```bash
/usr/bin/sh -c /usr/bin/etckeeper -l 2 post-install
```

"""]]
```
Tokens:
Raw