Introduction
WebMail Lite offers integration with various external services: Google, Facebook and Dropbox. For each of those services, integration is configured in the similar way - in a console offered by that service, you create an application and obtain a set of parameters used for authentication, and specify those parameters in WebMail Lite admin interface section. Once that's done, users will be able to authenticate via those services and use access file storage where applicable.
Google
This configuration will allow your users to authenticate with their Google accounts and access their Google Drive storage.
IMPORTANT: For this to work, WebMail Lite must be running on SSL-enabled (https) host.
Setting up application in Google
- Navigate to https://console.cloud.google.com/cloud-resource-manager and click Create Project. Supply arbitrary Project Name and click Create. Once the project is created, click Select Project.
- In navigation menu (top-left corner), select APIs & Services -> Library, locate Google Picker API and enable this API. Then go back to Library, locate Google Drive API and enable it.
- In left pane, select OAuth consent screen. Select "External" option for creating consent screen. Supply arbitrary Product name shown to users, make sure the correct list of Authorized domains is supplied and click Save button.
- In left pane, select Credentials and click Create credentials button. Choose API key option. API key created will be shown, you should save it to use in WebMail Lite settings.
- Click Create credentials button and choose Oauth cliend ID option. Application type needs to be set to "Web application".
In Authorized JavaScript Origins, WebMail Lite root domain URL of the installation needs to be supplied. For example, if your installation is at https://yourdomain.com/webmail/
then it's https://yourdomain.com/
URL you need to specify.
In Authorized Redirect URIs list, URLs of the following kind must be added: http://yourdomain.com/webmail/?oauth=google
where http://yourdomain.com/webmail/
is WebMail Lite installation URL.
Upon clicking Create button, client ID and client secret will be shown. You should save those to use in WebMail Lite settings.
Performing configuration in WebMail Lite
Under System > Google Auth screen of admin interface, check Google connector and specify the following values for it, using those obtained from Google Developers Console:
App ID
should be set to CLIENT ID value; App Secret
is set to CLIENT SECRET; API Key
equals API KEY value. The value is optional, it's needed to let users add shortcuts to Google Drive documents.
Facebook
Allows for authentication with Facebook account.
Creating Facebook application
- Navigate to https://developers.facebook.com/apps and click Create a new app.
- On the left pane, select Settings > Basic tab, and supply product installation URL in App Domains and Site URL fields.
- From the same page, obtain App ID and App Secret values.
- Add "Facebook Login" product and configure it by specifying installation URL and enable "Web OAuth Login".
- Make sure you have the following option enabled on Status & Review tab:
Do you want to make this app and all its live features available to the general public?
Performing configuration in WebMail Lite
- Under System > Facebook Auth screen of admin interface, enable Facebook connector by selecting its checkbox.
App ID
and App Secret
values should be set to those obtained from Facebook Developer console.
Dropbox
Integration with Dropbox allows WebMail Lite users to authenticate with their Dropbox accounts and access their Dropbox storage.
IMPORTANT: For this to work, WebMail Lite must be running on SSL-enabled (https) host.
Setting up Dropbox app
- Open Dropbox App Console. You'll be asked to log into your Dropbox account if you're not logged in yet.
- Click Create App button, then fill the parameters of your application as follows:
- Supply arbitrary application name and click Create App.
- On next screen, the product installation domain(s) must be added under Chooser/Saver domains list. To Redirect URIs list, URLs of the following kind must be added:
http://yourdomain.com/webmail/?oauth=dropbox
where http://yourdomain.com/webmail/
is product installation URL. - Copy App key and App secret values from that screen.
Setting up Dropbox integration in WebMail Lite
- Under System > Dropbox Auth screen of admin interface, enable Dropbox connector by selecting its checkbox;
App ID
is set to App key value obtained from Dropbox App Console; App Secret
should be set to App secret value;
Removing restrictions of Dropbox integration
By default, a single Dropbox app can only be accessed by up to 100 users. To remove the limit, you'll need to apply for production status as described here.