Installation guide¶
Prerequisites¶
- Dolibarr ≥ 3.2
- PHP ≥ 5.3
- PHP extensions
- CURL
- JSON
Installation¶
Recommended: “custom” directory¶
Make sure the custom directory is enabled [1].
Unzip the archive in htdocs/custom
directory.
Legacy: “htdocs” directory¶
Unzip archive in htdocs/
directory.
Note
Make sure that your webserver’s user has read and directory traversal permissions on the folder and it’s content.
Footnotes
[1] | Edit the file htdocs/conf/conf.php and uncomment the lines $dolibarr_main_url_root_alt
and $dolibarr_main_document_root_alt . |
Administrator’s guide¶
Note
This module is designed to authenticate your request against Google services. An Internet access is required.
You can’t use this module if it is not fully configured.
Activation¶
You need to have admin privileges to activate the module.
Navigate to ON
and switch it toTodo
Add screenshot
Setup¶
You must register Dolibarr in the Google Developers Console to allow it to communicate with Google.
Google Cloud Console¶
Google API Configuration¶
Sign in with your Google account.
Todo
Add screenshot
Create a new project with the button Create project.
Choose a Project Name (for example Dolibarr).
Eventually accept the terms of service.
Click Create”`
Wait until the project opens automatically.
Todo
Add screenshot
Use Enable an API from the dashboard or the ”` menu.
Enable the required APIs for your modules (Status ON).
Module | APIs |
---|---|
ZenFusion Contacts |
|
ZenFusion Drive |
|
Client ID¶
Go to
.Click Create new client ID.
Todo
Add screenshot
Use the following parameters:
Application type: | |
---|---|
Web application | |
Authorized Javascript origins: | |
Dolibarr’s adress | |
Authorized redirect URI: | |
Copy and paste URL using the Copy to clipboard button (Configuration tab from Dolibarr’s ZenFusion OAuth module). |
Todo
Add screenshot
Configuration file¶
Todo
Add screeshot
Download the file using the Download JSON button from the new Client ID and upload it using the form (Setup tab from Dolibarr’s ZenFusion OAuth module).
Congratulations!
You just enabled Dolibarr communicating with Google.
Warning
For security reasons, destroy the downloaded file after use. Or at least make sure it’s stored in a safe way.
Permissions¶
Module provides a user permission. This allows or denies access to all functions.
It is only enabled for admin by default and should be enabled for each desired user or group.
You can find it in the user card User permissions tab or group card Group permissions tab.
User setup¶
See User’s guide
User’s guide¶
Setup¶
Todo
Add screenshot
Warning
Your e-mail adress must be same as the Google account’s.
Each user has to enable his Google account to communicate with Dolibarr. Go to Activate and follow the instructions
, click onCongratulations!
You now have access to the enabled services.
Note
You can also use this page to disable the services.
ZenFusion OAuth¶
This module provides Google APIs OAuth 2 authentication client capabilities to Dolibarr.
It is designed to be used with other ZenFusion modules.
License¶
Copyright (C) 2011-2016 GPC.solutions
GPLv3 or (at your option) any later version.
See COPYING for more information.
Composer¶
This project uses composer to manage external dependencies.
Please see https://getcomposer.org for more informations.
First use¶
Please issue the following command at the project root after clone to install required dependencies:
- Production:
composer install --no-dev
- Development:
composer install
Updates¶
After pulling, use composer update
to update the dependencies.
Welcome to ZenFusion OAuth’s documentation!¶
Danger
Migration to this documentation system is still a work in progress.
Please check the current documentation at modules.gpcsolutions.fr.
Download: | |
---|---|
Latest release: | 3.0.2 |
Licence: | GPLv3+ ©2011-2016 GPC.solutions |
Informations: | |
Developers: |
|
Contributors: | N.A. |
Translators: | N.A. |
Todo
Add ZenFusion OAuth logo
Add GPLv3 logo
Add GFDL logo in footer
Add contribution guidelines (code, documentation, translations of both)
Warning
This module does nothing on it’s own.
It is designed to provide authentication services to other ZenFusion modules like Contacts and Drive.