The contact importer and exporter plugin for the Kopano WebApp. See here for more details: https://community.zarafa.com/pg/plugins/project/20393/developer/h44z/webapp-contact-importer
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.6KB

3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. CONTACT IMPORTER AND EXPORTER:
  2. ===
  3. ## Building the contact importer plugin from source:
  4. ### Dependencies
  5. - Kopano WebApp Source Code (https://stash.kopano.io/projects/KW/repos/kopano-webapp/browse)
  6. - PHP >= 5 (7 or higher recommended)
  7. - composer (https://getcomposer.org/)
  8. - JDK 1.8 (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
  9. - ant (http://ant.apache.org/)
  10. Add JAVA_HOME (e.g. C:\Program Files\Java\jdk1.8.0_161) to your path. Also add Ant, Composer, PHP and Java to the global PATH variable!
  11. ### Compiling the plugin
  12. Unzip (or use git clone) the sourcecode of Kopano WebApp to a new directory. In this README we call the source folder of WebApp "kopano-webapp-source".
  13. Then generate the WebApp build utils:
  14. ```
  15. cd kopano-webapp-source
  16. ant tools
  17. ```
  18. Next clone the plugin to the WebApp plugin directory:
  19. ```
  20. cd kopano-webapp-source\plugins
  21. git clone https://git.sprinternet.at/zarafa_webapp/contactimporter.git
  22. ```
  23. Now lets build the plugin:
  24. ```
  25. cd kopano-webapp-source\plugins\contactimporter\php
  26. composer install
  27. cd kopano-webapp-source\plugins\contactimporter
  28. ant deploy
  29. ```
  30. The compiled plugin is saved to `kopano-webapp-source\deploy\plugins\contactimporter`.
  31. ## Installing the plugin
  32. ### From compiled source
  33. Copy the whole folder "contactimporter" to your production WebApp (`kopano-webapp-production\plugins\contactimporter`)
  34. For example:
  35. ```
  36. cp -r kopano-webapp-source\deploy\plugins\contactimporter kopano-webapp-production\plugins\
  37. ```
  38. ### From precompiled download
  39. Download the newest release from https://git.sprinternet.at/zarafa_webapp/contactimporter/tree/master/DIST.
  40. Unzip the downloaded file and copy the plugin folder to your production WebApp.
  41. For example:
  42. ```
  43. cp -r Downloads\contactimporter kopano-webapp-production\plugins\
  44. ```
  45. ## Configuration
  46. Edit the config.php file in the plugin root path to fit your needs.
  47. Available configuration values:
  48. | Configuration Value | Type | Default | Desctription |
  49. | ------------- |:-------------:| ----- | ----- |
  50. | PLUGIN_CONTACTIMPORTER_USER_DEFAULT_ENABLE | boolean | false | Set to true to enable the plugin for all users |
  51. | PLUGIN_CONTACTIMPORTER_DEFAULT | string | "Kontakte" | Default contact folder name (might be "Contacts" on english installations) |
  52. | PLUGIN_CONTACTIMPORTER_TMP_UPLOAD | string | "/var/lib/kopano-webapp/tmp/" | Temporary path to store uploaded v-Cards |
  53. ## Usage
  54. The plugin add context menu entries to contact folders.
  55. ![Plugin Context Menus](https://git.sprinternet.at/zarafa_webapp/contactimporter/raw/master/usage.png "Kopano Webapp Context Menu")