Skip to content

Commit

Permalink
Adjust README for socket activation feature
Browse files Browse the repository at this point in the history
Signed-off-by: Iavael <905853+iavael@users.noreply.github.com>
  • Loading branch information
iavael committed Jan 17, 2023
1 parent 05ca6a2 commit cb57b6d
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions cmd/gitsign-credential-cache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,35 @@ that is used is output by `gitsign-credential-cache` when it is spawned. See
[os.UserCacheDir](https://pkg.go.dev/os#UserCacheDir) for details on how the
cache directory is selected.

### Systemd service
There are systemd user units in contrib

Change path to gitsign-credential-cache in service unit

```bash
${EDITOR:-vi} ./contrib/gitsign-credential-cache.service
```

Install units in home directory for specific user

```bash
install -m 0660 -D -t $HOME/.config/systemd/user/ ./contrib/gitsign-credential-cache.{socket,service}
systemctl --user daemon-reload
```

OR install them for all users

```bash
sudo install -m 0660 -D -t /etc/systemd/user/ ./contrib/gitsign-credential-cache.{socket,service}
sudo systemctl daemon-reload
```

After that you can enable and start socket service

```bash
systemctl --user enable --now gitsign-credential-cache.socket
```

### Forwarding cache over SSH

(Requires gitsign >= v0.5)
Expand Down

0 comments on commit cb57b6d

Please sign in to comment.