-
Notifications
You must be signed in to change notification settings - Fork 137
Google Workspace setup
Edoardo edited this page Aug 18, 2021
·
3 revisions
- Visit https://admin.google.com/ac/apps
- Click "Web and mobile apps"
- Click "Add App" --> "Add custom SAML app"
- Enter a name, e.g. "Munkireport" and click "Continue"
- Download the IdP Metadata, or make note of the following information as this information needs to be added to your Munkireport server configuration:
- SSO URL (e.g.
https://accounts.google.com/o/saml2/idp?idpid=C01abcdef
) - Entity ID (e.g.
https://accounts.google.com/o/saml2?idpid=C01abcdef
) - Certificate
- SSO URL (e.g.
- Click "Continue"
- Enter the ACS URL for your Munkireport instance (e.g.
https://munkireport.domain.com/auth/saml/acs
) - Enter the Entity ID for your Munkireport instance (e.g.
https://munkireport.domain.com/auth/saml/metadata
) - Change the "Name ID format" to
EMAIL
- You can leave all other settings the same and click "Continue"
- Click "Add Mapping" and add the following:
- User Mapping attribute which can be used when allowing specific users:
- Field: "Basic Information" --> "Primary email"
- App attributes: Enter "email"
- (Optional) Group Mapping attribute which can be used when allowing specific groups of users:
- Field: This will be dependent on your needs and Google setup. You could map a custom attribute, or something like "Employee Details" --> "Department" if you were scoping access based on a Department
- App attributes: This will again be dependent on the field you chose above. It should logically map to the attribute chosen. For something like the "Department" field, you can name this "department"
- User Mapping attribute which can be used when allowing specific users:
- Click "Finish"
In your Munkireport .env
file add:
AUTH_METHODS=SAML
AUTH_SAML_SP_NAME_ID_FORMAT=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
AUTH_SAML_IDP_ENTITY_ID=<Entity ID from your Google SAML app>
AUTH_SAML_IDP_SSO_URL=<SSO URL from your Google SAML app>
AUTH_SAML_IDP_SLO_URL=https://accounts.google.com/logout # this value is the same for all Google SAML apps
AUTH_SAML_IDP_X509CERT=<YOUR CERTIFICATE>
AUTH_SAML_USER_ATTR=email
- General Upgrade Procedures
- How to Upgrade Versions
- Troubleshooting Upgrades
- Migrating sqlite to MySQL