Last modified by Administrator on 2024/03/03 00:00
<
From version < 144.1 >
edited by Silvia Macovei
on 2018/11/07 15:50
To version < 146.1 >
edited by Silvia Macovei
on 2018/11/07 15:54
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,30 +1,21 @@
1 -{{extensionToc/}}
1 +The Google Apps Integration allows you to integrate XWiki with Google's editing application (Google Docs, Spreadsheet, Presentations and Drawing). Thanks to this application it is possible to:
2 2  
3 -This is the distribution for the Google Apps extension, allowing to integrate XWiki with Google's editing application (Google Docs, Spreadsheet, Presentations and Drawing). Thanks to this application it is possible to easily import a Google Apps document as an attachment in XWiki (in multiple formats) and also to launch editing of an XWiki attachment in Google Apps. Once your editing session is finished you can reimport it in XWiki.
3 +* log in to XWiki using your Google account
4 +* easily import a Google Apps document as an attachment in XWiki (in multiple formats)
5 +* launch editing of an XWiki attachment in Google Apps. Once the editing session is finished you can reimport it in XWiki.
4 4  
5 5  This integration uses the OAuth2 protocol to connect Google Apps with XWiki. It works with individual Google accounts as well as company wide Google Apps accounts.
6 6  
7 -The configuration of the application is available on the wiki Administration under the **Other** section:
9 +To activate Google Apps you need to [[register for OAuth access on Google.com>>https://accounts.google.com/ManageDomains]] and insert your domain name and key in the settings from the XWki Administration. To see how you can register for OAuth access please read the [[dedicated section in the Installation instructions>>||anchor="installation"]].
8 8  
9 -{{image reference="applicationConfiguration.png"/}}
11 +Once you have properly configured the application, you will be able to log in with your Google credentials and see the feature in the Attachments section of XWiki pages. You can either click on the edit link next to each attachment or use the **Import from Google Apps** button.
10 10  
11 -To activate Google Apps you need to [[register for OAuth access on Google.com>>https://accounts.google.com/ManageDomains]] and next insert your domain name and key in the settings from the wiki Administration section **Google Apps**. You will find more information about registration in [[Google's registration documentation>>http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html]].
13 +{{image reference="GoogleLogin.png" width="400"/}}
12 12  
13 -= Activate Google Authentication =
15 +{{image reference="googleapps.png" width="750"/}}
14 14  
15 -To activate the Groovy Authentication you need to update the following settings in **xwiki.cfg**:
16 -
17 -{{code}}
18 -xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
19 -xwiki.authentication.groovy.pagename=xwiki:GoogleApps.AuthService
20 -{{/code}}
21 -
22 -Once you have properly configured the application, you will be able to see the feature in the Attachments section of XWiki pages. You can either click on the edit link next to each attachment or use the **Import from Google Apps** button.
23 -
24 -{{image reference="googleapps.png"/}}
25 -
26 26  You can also use the **drive** macro to insert (embed) a Google Document in your page.
27 27  
28 -{{image reference="googlemacro.png"/}}
19 +{{image reference="googlemacro.png" width="550"/}}
29 29  
30 -{{image reference="searchfordocument.png"/}}
21 +{{image reference="searchfordocument.png" width="850"/}}
Prerequisites & Additional Installation Instructions
... ... @@ -1,1 +1,71 @@
1 1  {{include reference="Store.Code.PayingAppInstallInstructions"/}}
2 +
3 +== Register for OAuth access ==
4 +
5 +=== Create a Google project for your app ===
6 +
7 +Go to https://console.developers.google.com/ (see also https://developers.google.com/identity/protocols/OAuth2?hl=en). Create a Google project for your app as shown below:
8 +
9 +{{image reference="CreateGoogleProject.png" width="550"/}}
10 +
11 +=== Enable the Google+ API ===
12 +
13 +Moving forward, you will need to Enable the Google+ API. This API is needed to access the Google account information. To enable it go back to the dashboard and click on ##ENABLE APIS AND SERVICES##, search for ##Google+ API## and click ##ENABLE##
14 +
15 +{{image reference="Google+API.png" width="500"/}}
16 +
17 +=== Enable the Google Drive API ===
18 +
19 +This API is needed to access Google documents. Similarly, to enable it go back to the dashboard and click on ##ENABLE APIS AND SERVICES##, search for ##Google Drive API## and click ##ENABLE##
20 +
21 +{{image reference="GoogleDriveAPI.png" width="500"/}}
22 +
23 +=== Generate the Google Client ID and Secret ===
24 +
25 +In order to start using the integration, the Google Client ID and Secret will need to be generated and added to the Google Apps Configuration page.
26 +
27 +Open the project and go to ##Credentials > OAuth consent screen##.
28 +
29 +{{image reference="CredentialsOAuth.png" width="700"/}}
30 +
31 +Set up the OAuth client inside the Google project by filling in the following fields:
32 +
33 +* Application name
34 +* Authorized domains
35 +* Application Homepage link
36 +* Application Privacy Policy link
37 +
38 +{{image reference="CredentialsOAuth2.png" width="650"/}}
39 +
40 +Note Google does not accept ##localhost## for these fields. This tutorial uses the alias ##apps.xwiki.com##. Depending on your OS you will need to also update the hosts file to which you should add the following IP/Alias pair: **your IP your Application Homepage link** (e.g. 127.0.0.1 apps.xwiki.com).
41 +
42 +After setting up the OAuth client go back to Credentials and click on ##Create credentials > Create OAuth client ID##.
43 +
44 +{{image reference="CreateCredentials" width="600"/}}
45 +
46 +Select "Web Application" and fill in the name and the Authorized redirect URI. The Authorized redirect URI needs to end with ##GoogleApps/Oauth##. Make sure you hit enter after filling in the Authorized redirect URI, otherwise the value will not be saved. Then click the ##Create## button.
47 +
48 +{{image reference="ClientIDWebApplication" width="650"/}}
49 +
50 +A popup will appear with the Client ID and Client Secret.
51 +
52 +{{image reference="IDSecret.png" width="500"/}}
53 +
54 +Next you will need to update the Client ID and Secret inside the XWiki Administration from the Google Apps Integration Configuration section.
55 +
56 +{{image reference="applicationConfiguration.png"/}}
57 +
58 +== Activate the Google Authentication ==
59 +
60 +Finally, to activate the Groovy Authentication you need to update the following settings in the **xwiki.cfg** file (##webapps > xwiki > WEB-INF##) and restart the wiki:
61 +
62 +{{code}}
63 +xwiki.authentication.authclass=com.xpn.xwiki.user.impl.xwiki.GroovyAuthServiceImpl
64 +xwiki.authentication.groovy.pagename=xwiki:GoogleApps.AuthService
65 +{{/code}}
66 +
67 +If you are an XWiki Cloud user you do not have direct access to this file. You will need to contact the XWiki Support team to perform this change for you.
68 +
69 +{{warning}}
70 +**Warning: If you have the Active Directory Application installed, the Google Apps integration will not work. The reason is that this application overwrites the configured authenticator. To try out the Google Apps integration you will need to uninstall the "Active Directory Authenticator" extension. Note that uninstalling only the "Active Directory Application" is not enough because the authenticator is a dependency of the application and the Extension Manager doesn't uninstall the dependencies when you uninstall the application. You may also need to clear the cookies associated to the domain used by your XWiki instance, then try again to sign in with Google.**
71 +{{/warning}}
Properties
... ... @@ -1,2 +1,1 @@
1 -maven.groupid=com.xwiki.googleapps maven.artifactid=application-googleapps maven.Model=com.xwiki.googleapps:application-googleapps:xar:2.3.4 xwiki.extension.licensing.publicDocuments=GoogleApps.WebHome xwiki.extension.licensing.excludedDocuments=GoogleApps.GoogleAppsConfig,
2 - GoogleApps.WebPreferences
1 +maven.groupid=com.xwiki.googleapps maven.artifactid=application-googleapps maven.Model=com.xwiki.googleapps:application-googleapps:xar:2.3.4 xwiki.extension.licensing.publicDocuments=GoogleApps.WebHome xwiki.extension.licensing.excludedDocuments=GoogleApps.GoogleAppsConfig, GoogleApps.WebPreferences
Summary
... ... @@ -1,1 +1,1 @@
1 -This extension allows to connect Google Apps to XWiki
1 +This application allows you to log in to XWiki using your Google account, import Google Apps documents as XWiki attachments and edit an XWiki attachment in Google Apps.
ExtensionCode.ExtensionVersionClass[4]
Release Notes
... ... @@ -1,2 +1,1 @@
1 1  Update the Licensing dependency to version 1.13.
2 -
XWiki SAS Copyright © 2024