Skip to content
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.

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

Documentation Overhaul #271

Open
robellegate opened this issue Aug 1, 2019 · 8 comments
Open

Documentation Overhaul #271

robellegate opened this issue Aug 1, 2019 · 8 comments

Comments

@robellegate
Copy link
Contributor

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
Copy link
Member

peppelinux commented Aug 1, 2019 via email

@robellegate
Copy link
Contributor Author

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
Copy link
Member

Also related to
#217

@FabianGrob
Copy link

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
Copy link
Contributor

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
Copy link
Member

peppelinux commented Jul 5, 2022 via email

@FabianGrob
Copy link

Where may i ask this kind of questions?

@vladimir-mencl-eresearch
Copy link
Contributor

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/

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

No branches or pull requests

4 participants