Documentation Overhaul

[robellegate]

The documentation for this project needs an overhaul. There isn't a lot of structure to the current documentation, it's very difficult to find how to configure the various frontend/backend plugins without either digging into the codebase to see how the configuration files are being serialized.

For long-term support, I believe this project needs better documentation. It should be using either something like pydoc, which is already being used by the pysaml2 project, or something like MkDocs.

I am willing to help contribute to efforts of improving documentation, but I wanted to leave the decision of if/how it's implemented to the maintainers and community.

Code Version

Branch: Master
Commit: d8bb07a

[peppelinux]

A readthedocs page would be a good Place I think. Probably we should also document all the pysaml2 configuration options that are actually undocumented at this moment. All the Saml2 backend/frontend parameters rely on those belonging to pysaml2. Il gio 1 ago 2019, 16:47 Robert Ellegate <notifications@github.com> ha scritto:

…

The documentation for this project needs an overhaul. There isn't a lot of structure to the current documentation, it's very difficult to find how to configure the various frontend/backend plugins without either digging into the codebase to see how the configuration files are being serialized. For long-term support, I believe this project needs better documentation. It should be using either something like pydoc, which is already being used by the pysaml2 <http://../../pysaml2> project, or something like MkDocs. I am willing to help contribute to efforts of improving documentation, but I wanted to leave the decision of if/how it's implemented to the maintainers and community. Code Version *Branch:* Master *Commit:* d8bb07a <d8bb07a> — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#271?email_source=notifications&email_token=AAJ4ZVBZZW4X2JJKJSQMVJLQCLZRNA5CNFSM4IIRO4EKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HC3AM3Q>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJ4ZVHCJZTQW2ZV2GGZQ6DQCLZRNANCNFSM4IIRO4EA> .

[robellegate]

Probably we should also document all the pysaml2 configuration options that are actually undocumented at this moment. All the Saml2 backend/frontend parameters rely on those belonging to pysaml2.

I completely agree. I didn't know the local metadata provider type could work with both aggregate files and directories until I dug into the pysaml2 source code.

[peppelinux]

Also related to
#217

[FabianGrob]

Hi,
I am trying to use Satosa to implement a solution for several idps, and i do not find it completely clear how idps are added to satosa configuration.
Maybe it is a language barrier, can sameone give a detailed guide on how to add new idps. I found some as google in the documentation but i cannot reproduce them.

Thanks in advance

[vladimir-mencl-eresearch]

Hi, I am trying to use Satosa to implement a solution for several idps, and i do not find it completely clear how idps are added to satosa configuration. Maybe it is a language barrier, can sameone give a detailed guide on how to add new idps. I found some as google in the documentation but i cannot reproduce them.

Thanks in advance

Hi,

This is not really place to ask documentation questions ... but, if you are after configuring multiple IdPs for a SAML SP (using the saml2 backend), you can just add more entries into the metadata part of the config - as here in the sample config: https://github.com/IdentityPython/SATOSA/blob/master/example/plugins/backends/saml2_backend.yaml.example#L31

Cheers,
Vlad

[peppelinux]

Hi, Try the readme here https://github.com/italia/Satosa-Saml2Spid best Il mar 5 lug 2022, 19:47 FabianGrob ***@***.***> ha scritto:

…

Hi, I am trying to use Satosa to implement a solution for several idps, and i do not find it completely clear how idps are added to satosa configuration. Maybe it is a language barrier, can sameone give a detailed guide on how to add new idps. I found some as google in the documentation but i cannot reproduce them. Thanks in advance — Reply to this email directly, view it on GitHub <#271 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJ4ZVAXOXAWQVL5755FMHDVSRYK7ANCNFSM4IIRO4EA> . You are receiving this because you commented.Message ID: ***@***.***>

[FabianGrob]

Where may i ask this kind of questions?

[vladimir-mencl-eresearch]

Where may i ask this kind of questions?

The bottom of the README file has:

If you have any questions regarding operations/deployment of SATOSA please use the satosa-users mailing list.

So https://lists.sunet.se/postorius/lists/idpy-discuss.lists.sunet.se/