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.

122 lines
4.0 KiB

  1. ====================
  2. dbfilter_from_header
  3. ====================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/dbfilter_from_header
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-dbfilter_from_header
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This addon lets you pass a dbfilter as a HTTP header.
  25. This is interesting for setups where database names can't be mapped to proxied host names.
  26. **Table of contents**
  27. .. contents::
  28. :local:
  29. Installation
  30. ============
  31. To install this module, you only need to add it to your addons, and load it as
  32. a server-wide module.
  33. This can be done with the ``server_wide_modules`` parameter in ``/etc/odoo.conf``
  34. or with the ``--load`` command-line parameter
  35. ``server_wide_modules = "web, dbfilter_from_header"``
  36. Configuration
  37. =============
  38. Please keep in mind that the standard odoo dbfilter configuration is still
  39. applied before looking at the regular expression in the header.
  40. * For nginx, use:
  41. ``proxy_set_header X-Odoo-dbfilter [your filter regex];``
  42. * For caddy, use:
  43. ``proxy_header X-Odoo-dbfilter [your filter regex]``
  44. * For Apache, use:
  45. ``RequestHeader set X-Odoo-dbfilter [your filter regex]``
  46. And make sure that proxy mode is enabled in Odoo's configuration file:
  47. ``proxy_mode = True``
  48. Usage
  49. =====
  50. To use this module, you need to complete installation and configuration
  51. parts.
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20dbfilter_from_header%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * Therp BV
  64. Contributors
  65. ~~~~~~~~~~~~
  66. * Stéphane Bidoul <stephane.bidoul@acsone.eu>
  67. * Yannick Vaucher <yannick.vaucher@camptocamp.com>
  68. * Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
  69. * Holger Brunn <hbrunn@therp.nl>
  70. * Laurent Mignon (aka lmi) <laurent.mignon@acsone.eu>
  71. * Sandy Carter <sandy.carter@savoirfairelinux.com>
  72. * Fabio Vilchez <fabio.vilchez@clearcorp.co.cr>
  73. * Jos De Graeve <Jos.DeGraeve@apertoso.be>
  74. * Lai Tim Siu (Quaritle Limited) <info@quartile.co>
  75. Maintainers
  76. ~~~~~~~~~~~
  77. This module is maintained by the OCA.
  78. .. image:: https://odoo-community.org/logo.png
  79. :alt: Odoo Community Association
  80. :target: https://odoo-community.org
  81. OCA, or the Odoo Community Association, is a nonprofit organization whose
  82. mission is to support the collaborative development of Odoo features and
  83. promote its widespread use.
  84. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/dbfilter_from_header>`_ project on GitHub.
  85. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.