Skip to content

docs(config): fix keyring template so set_password matches lookup#167

Open
nicolasbisurgi wants to merge 1 commit into
masterfrom
fix/keyring-template-service-name
Open

docs(config): fix keyring template so set_password matches lookup#167
nicolasbisurgi wants to merge 1 commit into
masterfrom
fix/keyring-template-service-name

Conversation

@nicolasbisurgi

Copy link
Copy Markdown
Collaborator

Summary

Documentation-only fix. config/config.ini.template showed a
keyring.set_password command that stored the secret under a
service/account combination RushTI never queries.

Code lookup (src/rushti/tm1_integration.py:93):
keyring.get_password(<instance_name>, <user>)

Old template:
keyring.set_password('TM1py', 'tm1srv01', 'mypassword') — stored under
service 'TM1py', account <instance>. Never matched.

Fixed template:
keyring.set_password('<instance>', '<user>', 'mypassword') — now
matches what the code reads.

Also documents the missing use_keyring=true step; keyring is opt-in
per section and the previous template omitted that.

No runtime change; template comment only.

Test plan

  • Copy template to config.ini, add use_keyring=true, run the
    updated keyring.set_password command, launch rushti run ...,
    confirm connection succeeds without the "no password found in
    keyring" warning.
  • Run the old command against a fresh keyring, confirm the warning
    still fires (proves the old template was wrong).

🤖 Generated with Claude Code

The example command stored the secret under service `'TM1py'` and account
`<instance>`, but `tm1_integration.resolve_tm1_params` looks it up as
`keyring.get_password(<instance>, <user>)`. Users who copied the template
verbatim got the fallback warning and an empty password.

Also documents the missing `use_keyring=true` step — keyring is opt-in
per section, and the previous template didn't say so.

Code path unchanged; docs only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@nicolasbisurgi nicolasbisurgi added the documentation Used for documentation only issues label Jul 1, 2026
@MariusWirtz

Copy link
Copy Markdown
Collaborator

Would it be possible to add a run mode where RushTI reads the password from the config.ini file and stores it in the Windows Credential Manager using Keyring?

The main use case is environments where the TM1 Service runs under a dedicated service account. In those cases, the Windows Credential Manager is account-specific, so the password has to be registered manually for that account. Having RushTI perform this step automatically would make the initial setup much simpler and avoid the need for manual intervention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Used for documentation only issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants