Skip to content

Repository files navigation

Alfresco Google Docs Integration / Module

Description

This extension adds the ability to edit supported content items in Google Docs™ to the Alfresco repository and Share interface. See also the Alfresco Google Docs Integration documentation.

When building from source you must include your own Google OAuth client secret json file. Instructions for creating it can be found at Google Drive REST API - Authorizing requests with OAuth 2.0.

The content of the generated file should be added to the appropriate client_secret-{community,enterprise}.json file found in Google Docs Repository/src/main/oauth-client-resources/.

Building

Windows users must ensure that the following value is set in Docker Engine > Edit JSON: “experimental: true”.

When building the amps (mvn clean package) you should also include a combination of the following profiles (-P). If not included, the defaults are applied.

Docker images

'local' Build amps for local dev/test only

'docker-end-to-end-setup' Build amps for future end-to-end tests

Example: mvn clean package -Plocal

AMP variants

Two AMPs can be built from the same source (the module is Java 17; build with JDK 21):

  • Default (zero-dependency): mvn clean package. The Google Drive SDK and its libraries are inherited as provided from the platform (alfresco-repository), so the AMP declares and bundles no third-party jars at all — it adds nothing to the ACS runtime classpath and relies on the platform to supply the SDK. Use on the ACS versions that ship the SDK: 26.3 and 25.5 (and later). These versions moved the SDK into the platform WARs, so the zero-dependency AMP must be used there.
  • Bundled (-Pbundled): mvn clean package -Pbundled. Packages the SDK inside the AMP (named ...+bundled.amp) so it is self-contained. Use on any ACS version that does not ship the SDK. Platform libraries (guava, jackson, httpclient, ...) stay provided, as those are always supplied by ACS.

The -Plocal / -Pbundled profiles can be combined (-Pbundled,local); the bundled test image installs onto ${acs.version} (default 26.2.1, the latest 26.x GA without the SDK; override with -Dacs.version=...).

Note: Amps built from this source are not supported by Alfresco. They are built and used at your own risk. Supported releases of the enterprise amps can be found at the Alfresco Customer Portal.

Contributing

Thanks for your interest in contributing to this project!

The following is a set of guidelines for contributing to this module. Most of them will make the life of the reviewer easier and therefore decrease the time required for the patch be included in a future version.

Ways to contribute would be by submitting pull requests, reporting issues and creating suggestions. In the case of a defect please provide steps to reproduce the issue, as well as the expected result and the actual one.

You can report an issue in the ALF jira project of the Alfresco issue tracker. Read instructions for a good issue report. Please also set the component as "GoogleDocs".

If you'd like a hand at trying to implement features yourself, please validate your changes by running the tests. Also pull requests should contain tests whenever possible. Please follow the coding standards.

As a contributor you must sign a contribution agreement, but please keep in mind that the contribution process includes a recorded acceptance step.

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

69 watching

Forks

Releases

Packages

Used by

Contributors

Languages