View Revisions: Issue #1027

Summary 0001027: Allow multiple Smartschool OAuth plug-ins
Revision 2019-01-28 16:18 by rijkr
Description IST: SavaPage allows for a single OAuth provider plugin (Google, Smartschool). When a single SavaPage instance contains users from multiple schools, with each school having its own Smartschool account, just one Smartschool OAuth plug-in can be configured.
SOLL: Allow multiple Smartschool OAuth instances. Add configuration items in Smartschool plug-in .properties file:
#-------------------------------------------------------------------
# Optional ID to make multiple Smartschool OAuth instances unique.
# The ID must contain 'a-z','A-Z','0-9', '-' and '_' characters only.
# "youraccount" is an obvious choice, but any other string will do.
#-------------------------------------------------------------------
#smartschool.plugin.id=youraccount

#-------------------------------------------------------------------
# Optional custom icon path relative to "server/custom/web/" 
# without leading '/'.
#-------------------------------------------------------------------
#smartschool.plugin.icon=com.example/smartschool.png

#-------------------------------------------------------------------
# Authorized redirect URL: must end with /user?sp-oauth=smartschool
#-------------------------------------------------------------------
# When smartschool.plugin.id is specified, append URL with: 
#   &sp-oauth-id=<smartschool.plugin.id>
#-------------------------------------------------------------------
smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool
#smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool&sp-oauth-id=youraccount
Extend URL path to SavaPage User Web App (as used from Smartschool), like this:
https://savapage.example.com/user/oauth/smartschool/<smartschool.plugin.id>
Revision 2019-01-28 16:17 by rijkr
Description IST: SavaPage allows for a single OAuth provider plugin (Google, Smartschool). When a single SavaPage instance contains users from multiple schools, with each school having its own Smartschool account, just one Smartschool OAuth plug-in can be configured.
SOLL: Allow multiple Smartschool OAuth instances. Add configuration items in Smartschool plug-in .properties file:
#-------------------------------------------------------------------
# Optional ID to make multiple Smartschool OAuth instances unique.
# The ID must contain 'a-z','A-Z','0-9', '-' and '_' characters only.
# "youraccount" is an obvious choice, but any other string will do.
#-------------------------------------------------------------------
#smartschool.plugin.id=youraccount

#-------------------------------------------------------------------
# Optional custom icon path relative to "server/custom/web/" 
# without leading '/'.
#-------------------------------------------------------------------
#smartschool.plugin.icon=com.example/smartschool.png

#-------------------------------------------------------------------
# Authorized redirect URL: must end with /user?sp-oauth=smartschool
#-------------------------------------------------------------------
# When smartschool.plugin.id is specified, append URL with: 
#   &sp-oauth-id=<smartschool.plugin.id>
#-------------------------------------------------------------------
smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool
#smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool&sp-oauth-id=youraccount

Extend URL path to SavaPage User Web App (as used from Smartschool), like this:
https://savapage.example.com/user/oauth/smartschool/<smartschool.plugin.id>
Revision 2019-01-28 16:12 by rijkr
Description IST: SavaPage allows for a single OAuth provider plugin (Google, Smartschool). When a single SavaPage instance contains users from multiple schools, with each school having its own Smartschool account, just one Smartschool OAuth plug-in can be configured.
SOLL: Allow multiple Smartschool OAuth instances. Add configuration items in Smartschool plug-in .properties file:
#-------------------------------------------------------------------
# Optional ID to make multiple Smartschool OAuth instances unique.
# The ID must contain 'a-z','A-Z','0-9', '-' and '_' characters only.
# "youraccount" is an obvious choice, but any other string will do.
#-------------------------------------------------------------------
#smartschool.plugin.id=youraccount

#-------------------------------------------------------------------
# Optional custom icon path relative to "server/custom/web/" 
# without leading '/'.
#-------------------------------------------------------------------
#smartschool.plugin.icon=com.example/smartschool.png

#-------------------------------------------------------------------
# Authorized redirect URL: must end with /user?sp-oauth=smartschool
#-------------------------------------------------------------------
# When smartschool.plugin.id is specified, append URL with: 
#   &sp-oauth-id=<smartschool.plugin.id>
#-------------------------------------------------------------------
smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool
#smartschool.oauth.callback-url=https://savapage.example.com/user?sp-oauth=smartschool&sp-oauth-id=youraccount