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.

119 lines
4.2 KiB

  1. ================
  2. MuK Web Branding
  3. ================
  4. This module complements the Branding Module. It serves to adapt the backend to
  5. your own needs. For example, a variety of colors can be adjusted directly in the
  6. settings. It is recommended to install
  7. `Saas Branding <https://apps.odoo.com/apps/modules/12.0/muk_saas_branding>`
  8. as well, but it is not strictly necessary.
  9. Installation
  10. ============
  11. To install this module, you need to:
  12. Download the module and add it to your Odoo addons folder. Afterward, log on to
  13. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  14. list by clicking on the "Update Apps List" link. Now install the module by
  15. clicking on the install button.
  16. Another way to install this module is via the package management for Python
  17. (`PyPI <https://pypi.org/project/pip/>`_).
  18. To install our modules using the package manager make sure
  19. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  20. correctly. Then open a console and install the module by entering the following
  21. command:
  22. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  23. The module name consists of the Odoo version and the module name, where
  24. underscores are replaced by a dash.
  25. **Module:**
  26. ``odoo<version>-addon-<module_name>``
  27. **Example:**
  28. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  29. Once the installation has been successfully completed, the app is already in the
  30. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  31. debug mode and update the list by clicking on the "Update Apps List" link. Now
  32. install the module by clicking on the install button.
  33. The biggest advantage of this variant is that you can now also update the app
  34. using the "pip" command. To do this, enter the following command in your console:
  35. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  36. When the process is finished, restart your server and update the application in
  37. Odoo. The steps are the same as for the installation only the button has changed
  38. from "Install" to "Upgrade".
  39. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  40. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  41. For modules licensed under OPL-1, you will receive access data when you purchase
  42. the module. If the modules were not purchased directly from
  43. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  44. with a confirmation of purchase to receive the corresponding access data.
  45. Upgrade
  46. ============
  47. To upgrade this module, you need to:
  48. Download the module and add it to your Odoo addons folder. Restart the server
  49. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  50. clicking on the upgrade button.
  51. If you installed the module using the "pip" command, you can also update the
  52. module in the same way. Just type the following command into the console:
  53. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  54. When the process is finished, restart your server and update the application in
  55. Odoo, just like you would normally.
  56. Configuration
  57. =============
  58. To configure this module, you need to:
  59. #. Go to *Settings -> General Settings -> Branding*.
  60. #. And set the parameters according to your needs.
  61. Usage
  62. =============
  63. After setting the parameters, the system is automatically branded.
  64. Credits
  65. =======
  66. Contributors
  67. ------------
  68. * Mathias Markl <mathias.markl@mukit.at>
  69. Images
  70. ------------
  71. Some pictures are based on or inspired by the icon set of Font Awesome:
  72. * `Font Awesome <https://fontawesome.com>`_
  73. Author & Maintainer
  74. -------------------
  75. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  76. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  77. We develop custom solutions for your individual needs to help you focus on
  78. your strength and expertise to grow your business.
  79. If you want to get in touch please contact us via mail
  80. (sale@mukit.at) or visit our website (https://mukit.at).