docs:Added documentation of Keyring Feature#2612
docs:Added documentation of Keyring Feature#2612ReimarBauer merged 8 commits intoOpen-MSS:developfrom
Conversation
There was a problem hiding this comment.
the description is currently to generic, it should be for a dev looking into this document become faster than looking into the code.
please look into the auth module where it is used and use the default names of the configuration, e.g.
for mscolab it is defined in MSCOLAB_auth_user_name, with "mscolab"
e.g. when auth on the mscolab server is enabled you want to ask. The URL is then the service url.
keyring get MSCOLAB_AUTH_{URL} mscolab
provide the examples based on what we do and need.
look on e.g. our usage of get_password_from_keyring e.g. https://github.com/Open-MSS/MSS/blob/develop/mslib/msui/mscolab.py#L205
all the descriptions done here can be later also retrieved by perplexity.ai or similiar.
ReimarBauer
left a comment
ReimarBauer
left a comment
There was a problem hiding this comment.
just looked at the form of the new docs.
This needs to become a section of development and not on same level.
See for the section codesbuilding-the-docs-with-sphinx
You need to start with a H2
looking on the content next.
docs/development.rst
Outdated
| like e.g. a running MSColab server or a QApplication instance for GUI tests, | ||
| are collected in :mod:`tests.fixtures` in the form of pytest fixtures that can be requested as needed in tests. | ||
|
|
||
| Testing Keyring Features |
There was a problem hiding this comment.
You can name it
Keyring Features
testing has some different meaning
|
|
||
| .. code-block:: bash | ||
|
|
||
| keyring set SERVICE_NAME USERNAME |
There was a problem hiding this comment.
the examples maybe should destinguish the http_auth protection and a user password.
When you use the keyring set MSCOLAB_AUTH_{url} [email protected] then it needs a change to keyring set MSCOLAB_AUTH_{url} MSCOLAB_auth_user_name the default in the configuration is mscolab.
There was a problem hiding this comment.
for the WMS Servers this username can differ for each server, an example is given in config.py
There was a problem hiding this comment.
mscolab has besides the common http_auth also user accounts and they are not described here.
These can become tested when you add a user with a password to your local running server.
There was a problem hiding this comment.
an example here would be
keyring set http://localhost:8083 myname@mydomain
Then when you started mscolab and use the myname@mydomain for this url it fills in your saved credentials and you are logged in by login.
anj20
changed the title
docs/development.rst
Outdated
| Testing Keyring Features | ||
| ========================= | ||
|
|
||
| This document outlines step-by-step instructions for testing keyring features using the command line. |
There was a problem hiding this comment.
for using the keyring feature
docs/development.rst
Outdated
|
|
||
| .. code-block:: bash | ||
|
|
||
| keyring set MSCOLAB_AUTH_{url} [email protected] |
There was a problem hiding this comment.
that is for an auth protection, when you setup an mscolab_auth.py and have this in your search path.
In that case it is as username not [email protected]. We use a name, in the default config it is just mscolab
using this as an example is then
keyring set MSCOLAB_AUTH_http://localhost:8083 mscolab
| .. code-block:: bash | ||
|
|
||
| keyring get MSCOLAB_AUTH_{url} [email protected] | ||
|
|
There was a problem hiding this comment.
this is again mixed two cases. here you would do an example
keyring get http://localhost:8083 myname@mydomain
There was a problem hiding this comment.
and for the case of an http_auth
keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
docs/development.rst
Outdated
|
|
||
| .. code-block:: bash | ||
|
|
||
| keyring delete MSCOLAB_AUTH_{url} [email protected] |
docs/development.rst
Outdated
| .. code-block:: bash | ||
|
|
||
| keyring get MSCOLAB_AUTH_{url} [email protected] | ||
|
|
There was a problem hiding this comment.
mixed again
we should have in the docs something a developer can use for the application.
This is also usefull when you have a new computer and want to transfer account data.
3 participants
Purpose of PR?:
Fixes #2421
Does this PR introduce a breaking change?
No
Does this PR results in some Documentation changes?
Yes
Added relevant documentation updates to Test Keyring Features.
Checklist:
<type>: <subject>