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.

116 lines
4.1 KiB

  1. ===================
  2. MuK Filestore Field
  3. ===================
  4. Provides a field to store bytes as a file in the filestore. This fields are useful
  5. with data values too large to be manipulated conveniently as a whole and a way to
  6. keep the database slim since it only has to save the path to the file and not the
  7. content itself.
  8. Installation
  9. ============
  10. To install this module, you need to:
  11. Download the module and add it to your Odoo addons folder. Afterward, log on to
  12. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  13. list by clicking on the "Update Apps List" link. Now install the module by
  14. clicking on the install button.
  15. Another way to install this module is via the package management for Python
  16. (`PyPI <https://pypi.org/project/pip/>`_).
  17. To install our modules using the package manager make sure
  18. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  19. correctly. Note that for Odoo version 11.0 and later this is not necessary anymore.
  20. Then open a console and install the module by entering the following command:
  21. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  22. The module name consists of the Odoo version and the module name, where
  23. underscores are replaced by a dash.
  24. **Module:**
  25. ``odoo<version>-addon-<module_name>``
  26. **Example:**
  27. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils``
  28. Once the installation has been successfully completed, the app is already in the
  29. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  30. debug mode and update the list by clicking on the "Update Apps List" link. Now
  31. install the module by clicking on the install button.
  32. The biggest advantage of this variant is that you can now also update the app
  33. using the "pip" command. To do this, enter the following command in your console:
  34. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  35. When the process is finished, restart your server and update the application in
  36. Odoo. The steps are the same as for the installation only the button has changed
  37. from "Install" to "Upgrade".
  38. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  39. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  40. For modules licensed under a proprietary license, you will receive the access data after you purchased
  41. the module. If the purchase were made at the Odoo store please contact our `support <support@mukit.at>`_
  42. with a confirmation of the purchase to receive the corresponding access data.
  43. Upgrade
  44. ============
  45. To upgrade this module, you need to:
  46. Download the module and add it to your Odoo addons folder. Restart the server
  47. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  48. clicking on the upgrade button.
  49. If you installed the module using the "pip" command, you can also update the
  50. module in the same way. Just type the following command into the console:
  51. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  52. When the process is finished, restart your server and update the application in
  53. Odoo, just like you would normally.
  54. Configuration
  55. =============
  56. No additional configuration is needed to use this module.
  57. Usage
  58. =====
  59. This module has no direct visible effect on the system. It adds a new field type,
  60. which can be used in other modules.
  61. Credit
  62. ======
  63. Contributors
  64. ------------
  65. * Mathias Markl <mathias.markl@mukit.at>
  66. Images
  67. ------
  68. Some pictures are based on or inspired by the icon set of Font Awesome:
  69. * `Font Awesome <https://fontawesome.com>`_
  70. Author & Maintainer
  71. -------------------
  72. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  73. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  74. We develop custom solutions for your individual needs to help you focus on
  75. your strength and expertise to grow your business.
  76. If you want to get in touch please contact us via `mail <sale@mukit.at>`_
  77. or visit our `website <https://mukit.at>`_.