Updated rngit docs

This commit is contained in:
Mark Qvist
2026-05-28 02:27:24 +02:00
parent f9c786fa28
commit a5ca1ee41e
4 changed files with 10 additions and 10 deletions
+3 -3
View File
@@ -1413,13 +1413,13 @@ Enabling Reticulum commit signing for all repositories is as simple as:
$ git config --global gpg.format ssh
$ git config --global gpg.ssh.program rngcs
$ git config --global gpg.ssh.allowedsignersfile
$ git config --global gpg.ssh.allowedsignersfile none
$ git config --global user.signingKey ~/.rngit/client_identity
With this configuration, all commits you sign with ``git commit -S`` will use your Reticulum identity.
.. note::
The ``gpg.ssh.allowedsignersfile`` configuration key **must** be *set* for ``git`` to allow invoking the signing and verification shim. It is not actually used by ``rngcs``, and can be set to an empty or arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.
The ``gpg.ssh.allowedsignersfile`` configuration key **must** be *set* for ``git`` to allow invoking the signing and verification shim. It is not actually used by ``rngcs``, and can be set to an arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.
**Per-Repository Configuration**
@@ -1430,7 +1430,7 @@ To enable signing only for a specific repository:
$ cd /path/to/repository
$ git config --local gpg.format ssh
$ git config --local gpg.ssh.program rngcs
$ git config --local gpg.ssh.allowedsignersfile
$ git config --local gpg.ssh.allowedsignersfile none
$ git config --local user.signingKey ~/.rngit/client_identity
This is useful when you want to use different identities for different projects, or when only specific repositories require signed commits.
+3 -3
View File
@@ -1368,21 +1368,21 @@ New identity <1a54d64db7e8beca6f2c6cd17b0cb479> written to /home/user/.rng
<p>Enabling Reticulum commit signing for all repositories is as simple as:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ git config --global gpg.format ssh
$ git config --global gpg.ssh.program rngcs
$ git config --global gpg.ssh.allowedsignersfile
$ git config --global gpg.ssh.allowedsignersfile none
$ git config --global user.signingKey ~/.rngit/client_identity
</pre></div>
</div>
<p>With this configuration, all commits you sign with <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span> <span class="pre">-S</span></code> will use your Reticulum identity.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">gpg.ssh.allowedsignersfile</span></code> configuration key <strong>must</strong> be <em>set</em> for <code class="docutils literal notranslate"><span class="pre">git</span></code> to allow invoking the signing and verification shim. It is not actually used by <code class="docutils literal notranslate"><span class="pre">rngcs</span></code>, and can be set to an empty or arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">gpg.ssh.allowedsignersfile</span></code> configuration key <strong>must</strong> be <em>set</em> for <code class="docutils literal notranslate"><span class="pre">git</span></code> to allow invoking the signing and verification shim. It is not actually used by <code class="docutils literal notranslate"><span class="pre">rngcs</span></code>, and can be set to an arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.</p>
</div>
<p><strong>Per-Repository Configuration</strong></p>
<p>To enable signing only for a specific repository:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd /path/to/repository
$ git config --local gpg.format ssh
$ git config --local gpg.ssh.program rngcs
$ git config --local gpg.ssh.allowedsignersfile
$ git config --local gpg.ssh.allowedsignersfile none
$ git config --local user.signingKey ~/.rngit/client_identity
</pre></div>
</div>
File diff suppressed because one or more lines are too long
+3 -3
View File
@@ -1330,14 +1330,14 @@ Enabling Reticulum commit signing for all repositories is as simple as:
```text
$ git config --global gpg.format ssh
$ git config --global gpg.ssh.program rngcs
$ git config --global gpg.ssh.allowedsignersfile
$ git config --global gpg.ssh.allowedsignersfile none
$ git config --global user.signingKey ~/.rngit/client_identity
```
With this configuration, all commits you sign with `git commit -S` will use your Reticulum identity.
#### NOTE
The `gpg.ssh.allowedsignersfile` configuration key **must** be *set* for `git` to allow invoking the signing and verification shim. It is not actually used by `rngcs`, and can be set to an empty or arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.
The `gpg.ssh.allowedsignersfile` configuration key **must** be *set* for `git` to allow invoking the signing and verification shim. It is not actually used by `rngcs`, and can be set to an arbitrary value. All validation operations happen exclusively based on the information in the embedded RSG data.
**Per-Repository Configuration**
@@ -1347,7 +1347,7 @@ To enable signing only for a specific repository:
$ cd /path/to/repository
$ git config --local gpg.format ssh
$ git config --local gpg.ssh.program rngcs
$ git config --local gpg.ssh.allowedsignersfile
$ git config --local gpg.ssh.allowedsignersfile none
$ git config --local user.signingKey ~/.rngit/client_identity
```