knowledge/document_url_google_drive/README.rst
2024-02-07 18:29:28 +00:00

145 lines
5.1 KiB
ReStructuredText

===========================
Google Drive URL Attachment
===========================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:87f75612d4443c8f053ffbfd02ff5f4d6a31cbb16218dfd0561f7589ae010da9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github
:target: https://github.com/OCA/knowledge/tree/16.0/document_url_google_drive
:alt: OCA/knowledge
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_url_google_drive
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/knowledge&target_branch=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module extends the functionality of the document_url module and
allows you to attach a link to a file from your Google Drive
**Table of contents**
.. contents::
:local:
Configuration
=============
To configure this module, you need to:
- Go to Settings -> General Settings and scroll down to the
Integrations section.
- Enable "Google API", save. Setup instructions
https://developers.google.com/drive/picker/guides/overview
- "Google Client ID" - enter the client ID from the Google API
console:
https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid
- "Google API key" - enter the API key from the Google API console.
- "Google App ID" - enter the ID of the Google application. The
default value is ``odoo``.
You will be asked to authenticate when you add a link for the first
time.
|Configuration|
**To modify your personal login credentials later**
- Open your user profile and set up personal access credentials on the
"Google API" tab.
- field "Google Scope" - enter the scope for the Google API. The
default value is
``https://www.googleapis.com/auth/drive.readonly``.
- field "Google Access Token" - your token will be displayed here.
It is necessary to edit it.
- field "Google Mime Types" - enter the file formats to be filtered
when selecting. Example:
``application/pdf, image/jpeg, image/png``. By default, all files
are selected
To log out from the current Google Account by clicking the "logout"
icon right to the "Add GDrive link".
.. |Configuration| image:: https://raw.githubusercontent.com/OCA/knowledge/16.0/document_url_google_drive/static/img/google_api_settings.png
Usage
=====
To use this module, you need to:
1. Open the form view of an object (Example: Customer Invoice
INV/2019/0007).
2. Go to the chatter and click on the attached icon.
3. Click **Add GDrive link**.
4. Fill the wizard fields and click on Add button.
5. In the open window, select the files you need and press the select
button.
6. You will see a new **URL attachment** in the set of attachments
related to the object.
7. In order to log in under another google user, click on the logout
icon located after **Add GDrive link**
|Google Drive Link|
.. |Google Drive Link| image:: https://raw.githubusercontent.com/OCA/knowledge/16.0/document_url_google_drive/static/img/gdrive_link.png
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/knowledge/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/knowledge/issues/new?body=module:%20document_url_google_drive%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
-------
* Cetmix
Contributors
------------
Cetmix <cetmix.com>
- Ivan Sokolov
- Mykola Demchuk
Maintainers
-----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
This module is part of the `OCA/knowledge <https://github.com/OCA/knowledge/tree/16.0/document_url_google_drive>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.