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.

126 lines
4.4 KiB

  1. ================
  2. MuK SaaS Branding
  3. ================
  4. This module complements the Branding Module. It introduces a new route to recive the
  5. favicon and adapts the existing route to receive the company logo to. You can also
  6. use parameters in the configuration file to specify the images and links on the
  7. database manager page.
  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. Then open a console and install the module by entering the following
  20. 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 odoo11-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 OPL-1, you will receive access data when you purchase
  41. the module. If the modules were not purchased directly from
  42. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  43. with a confirmation of purchase to receive the corresponding access data.
  44. Upgrade
  45. ============
  46. To upgrade this module, you need to:
  47. Download the module and add it to your Odoo addons folder. Restart the server
  48. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  49. clicking on the upgrade button.
  50. If you installed the module using the "pip" command, you can also update the
  51. module in the same way. Just type the following command into the console:
  52. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  53. When the process is finished, restart your server and update the application in
  54. Odoo, just like you would normally.
  55. Configuration
  56. =============
  57. Since this module need to be activated even if no database is selected it should
  58. be loaded right at the server start. This can be done by editing the configuration
  59. file or passing a load parameter to the start script.
  60. Parameter: ``--load=web,muk_saas_branding``
  61. The following fields can be modified in the config file:
  62. * database_manager_system_name
  63. * database_manager_system_logo_url
  64. * database_manager_system_favicon_url
  65. * database_manager_privacy_policy_url
  66. Usage
  67. =============
  68. After setting the parameters, the system is automatically branded.
  69. Credits
  70. =======
  71. Contributors
  72. ------------
  73. * Mathias Markl <mathias.markl@mukit.at>
  74. Images
  75. ------------
  76. Some pictures are based on or inspired by the icon set of Font Awesome:
  77. * `Font Awesome <https://fontawesome.com>`_
  78. Author & Maintainer
  79. -------------------
  80. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  81. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  82. We develop custom solutions for your individual needs to help you focus on
  83. your strength and expertise to grow your business.
  84. If you want to get in touch please contact us via mail
  85. (sale@mukit.at) or visit our website (https://mukit.at).