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

docs: document eduPUSH type and deprecate Push Token Type #294

Merged
merged 3 commits into from
Sep 1, 2024

Conversation

Luc1412
Copy link
Member

@Luc1412 Luc1412 commented Aug 27, 2024

This pull request updates documentation regarding:

  • EduPush Token Type
  • Mark old push token type as legacy and provides deprecation note

@Luc1412 Luc1412 linked an issue Aug 27, 2024 that may be closed by this pull request
@Luc1412 Luc1412 self-assigned this Aug 27, 2024
@Luc1412 Luc1412 marked this pull request as draft August 27, 2024 08:24
@Luc1412
Copy link
Member Author

Luc1412 commented Aug 27, 2024

@fritterhoff How do we want to communicate the change?

  • Do we want to call our new edupush token type Push Token or do we want to refer EduPush Token or eduPush Token or Edupush Token.
  • Depending on the first decision, how do we want to refer to the old Push Token type? Legacy Push Token or simply Push Token
  • If there are mentions of Push Token types, how do we want to refer to them? Should we mention both, just Edupush or should we summarize them as Push Token types?

Here also some special cases that needs to be clarified:

SMS Gateway Config

There it mentions the setup of firebase. The old docs refer to SLA with NetKnights to use the privacyIDEA app.

Now it's managed by GWDG, but how do people get access to our Firebase instance?

WebUI Config

There are show_android_privacyidea_authenticator and show_ios_privacyidea_authenticator we didn't replaced yet. What happens to these options?

Supported Tokens - Apps

There it mentions privacyIDEA Authenticator for HOTP, TOTP and PUSH. Should we keep it or remove it?

@fritterhoff
Copy link
Contributor

fritterhoff commented Aug 27, 2024

  • I would suggest eduMFA Push Token
  • We should use Legacy Push Token
  • Right now I would summarize them

Right now I check with the GWDG whats the preferred way to get access.

I think we should replace/extend the existing options... Maybe in the same PR or in a new.

Regarding HTOP, TOTP -> #288

@fritterhoff
Copy link
Contributor

The preferred way is to write an email to support@gwdg.de

@Luc1412 Luc1412 marked this pull request as ready for review August 30, 2024 10:23
@Luc1412 Luc1412 added the documentation Improvements or additions to documentation label Aug 30, 2024
@Luc1412 Luc1412 enabled auto-merge (squash) August 30, 2024 10:28
@fritterhoff fritterhoff changed the title Document EduPush Type and deprecate Push Token Type docs: document eduPUSH type and deprecate Push Token Type Sep 1, 2024
@Luc1412 Luc1412 merged commit f4fcec6 into main Sep 1, 2024
14 checks passed
@Luc1412 Luc1412 deleted the push-documentation branch September 1, 2024 05:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document edupush and (legacy) push token types
2 participants