Skip to content

Keychain access fallback to file-based credential storage #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jancurn merged 4 commits into from
Mar 5, 2026
Merged

Keychain access fallback to file-based credential storage #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6801342
Keychain access fallback to file-based credential storage
jancurn Mar 4, 2026
fd0d3ed
Better code
jancurn Mar 4, 2026
fc26de5
Lint
jancurn Mar 4, 2026
6fa2e0e
Fixes
jancurn Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- OS keychain now falls back to `~/.mcpc/credentials.json` (mode 0600) when no keyring daemon is available (e.g. headless Linux servers, containers)

## [0.1.10] - 2026-03-01

### Added
Expand Down
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,29 +48,29 @@ npm install -g @apify/mcpc
```

**Linux users:** `mcpc` uses the OS keychain for secure credential storage via the
[Secret Service API](https://specifications.freedesktop.org/secret-service/). Two things are required:
[Secret Service API](https://specifications.freedesktop.org/secret-service/).
On desktop systems (GNOME, KDE) this works out of the box. On headless/server/CI environments
without a keyring daemon, `mcpc` automatically falls back to a file-based credential store
(`~/.mcpc/credentials`, mode `0600`).

1. **`libsecret`** — the shared library (client side):
```bash
# Debian/Ubuntu
sudo apt-get install libsecret-1-0
To use the OS keychain on a headless system, install `libsecret` and a secret service daemon:

# Fedora/RHEL/CentOS
sudo dnf install libsecret
```bash
# Debian/Ubuntu
sudo apt-get install libsecret-1-0 gnome-keyring

# Fedora/RHEL/CentOS
sudo dnf install libsecret gnome-keyring

# Arch Linux
sudo pacman -S libsecret
```
# Arch Linux
sudo pacman -S libsecret gnome-keyring
```

2. **A running secret service daemon** — on desktop systems (GNOME, KDE) this is already provided
by gnome-keyring or KWallet. On headless/server/CI environments you need to install and start one:
```bash
# Debian/Ubuntu
sudo apt-get install gnome-keyring
And then run `mcpc` as follows:

# Then start it (e.g. in CI):
dbus-run-session -- bash -c "echo -n 'password' | gnome-keyring-daemon --unlock && your-command"
```
```
dbus-run-session -- bash -c "echo -n 'password' | gnome-keyring-daemon --unlock && mcpc ..."
```

## Quickstart

Expand Down
Loading
Loading