fork 0k-charms
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.

190 lines
4.5 KiB

  1. # -*- ispell-local-dictionary: "english" -*-
  2. #+TITLE: Monujo charm
  3. * Usage
  4. =monujo= service needs to know how to reach it's administrative backend.
  5. So either you specify one by yourself:
  6. #+begin_src yaml
  7. monujo:
  8. options:
  9. lokapi-host: http://admin.mycur.org
  10. #lokapi-db: odoo ## Default: 'odoo'
  11. #+end_src
  12. Either you can provide in sibling services an =odoo-server= providing
  13. service. It'll then discover it and use it by default as administrative
  14. backend.
  15. #+begin_src yaml
  16. monujo:
  17. odoo:
  18. #+end_src
  19. Note that =monujo= charm is describing a subordinate service, meaning
  20. that it'll run in an existing service providing =publish-dir= relation
  21. (creating one if not available).
  22. By default, =lokapi-db= if not set will be infered from option =dbname=
  23. in the relation =odoo-server=, or default database from =odoo-server=.
  24. So all these are equivalent:
  25. #+begin_src yaml
  26. monujo:
  27. options:
  28. lokapi-db: foo
  29. odoo:
  30. #+end_src
  31. #+begin_src yaml
  32. monujo:
  33. relations:
  34. odoo-server:
  35. odoo:
  36. dbname: foo
  37. odoo:
  38. #+end_src
  39. #+begin_src yaml
  40. monujo:
  41. odoo:
  42. relations:
  43. postgres-database:
  44. postgres:
  45. dbname: foo
  46. #+end_src
  47. If you don't want an active forcing on monujo configuration file, you
  48. can set option =enforce-config= to =false=. This will ensure that
  49. whatever is already deployed in the internal directory, it won't be
  50. replaced by the charm on next =compose up=.
  51. #+begin_src yaml
  52. monujo:
  53. options:
  54. version: 1.0.0-rc.3
  55. enforce-config: false
  56. odoo:
  57. #+end_src
  58. ** Map
  59. =monujo= optionaly can add a link to a map. If you want to do so, either
  60. add it explicitly, or add it automatically. This is the explicit way:
  61. #+begin_src yaml
  62. monujo:
  63. options:
  64. map-url: http://map.mycur.org
  65. #+end_src
  66. The map will be added automatically if a =map-server= provider is
  67. found (=gogocarto= charm creates services that provides =map-server=
  68. relations).
  69. #+begin_src yaml
  70. monujo:
  71. gogocarto:
  72. #+end_src
  73. ** Theming
  74. This charm allows to write all the =config.json= values supported by
  75. monujo, including the =theme= option, here's the default fully valued
  76. options of =theme= as of version =1.0.0-rc.3= of =monujo=:
  77. #+begin_src yaml
  78. monujo:
  79. options:
  80. lokapi-host: example.org
  81. lokapi-db: odoo
  82. map-url: https://carte.example.org
  83. help-url: https://help.com
  84. cgu-url: https://cgu.com
  85. local-password-retention-time: 900
  86. logo-url: https://example.com/img/logo.png
  87. login-logo-url: https://example.com/img/logo-2.png
  88. theme:
  89. color-1: "#e4f2f1"
  90. color-2: "#009688"
  91. top-menu-background-color: "#fefefe"
  92. top-menu-link-color: "#4a4a4a"
  93. top-menu-link-background-color: white
  94. top-menu-link-background-color-bg: white
  95. top-menu-link-hover-color: "#777777"
  96. top-menu-link-hover-color-bg: "#848484"
  97. top-menu-link-hover-background-color: whitesmoke
  98. top-menu-dropdown-divider-color: whitesmoke
  99. btn-payer-text-color: "#ffffff"
  100. btn-payer-border-color: $color-2
  101. btn-payer-background-color: $color-2
  102. btn-recevoir-text-color: "#ffffff"
  103. btn-recevoir-border-color: $color-2
  104. btn-recevoir-background-color: $color-2
  105. btn-recharger-text-color: $color-2
  106. btn-recharger-border-color: $color-2
  107. btn-recharger-background-color: "#ffffff"
  108. btn-login-text-color: "#ffffff"
  109. btn-login-border-color: $color-2
  110. btn-login-background-color: $color-2
  111. inner-card-background-color: "#f0faf9"
  112. inner-card-border-color: "#f0faf9"
  113. inner-card-text-color: "#4a4a4a"
  114. inner-card-text-color-backend: "#242424"
  115. inner-card-label-background-color: transparent
  116. inner-card-label-text-color: "#4a4a4a"
  117. inner-card-alt-text-color: "#009688"
  118. body-size: 14px
  119. tabs-border-bottom-color: white
  120. tabs-border-bottom-width: 4px
  121. tabs-link-hover-border-bottom-color: $color-2
  122. tabs-link-active-color: rgba(0 0 0 0.8)
  123. tabs-link-active-border-bottom-color: $color-2
  124. tabs-link-color: rgba(0 0 0 0.6)
  125. navbar-fixed-z: 50
  126. #+end_src
  127. ** Version
  128. The monujo app version deployed by this charm is set by default in
  129. =metadata.yml= in =default-options.version=.
  130. You can enforce a different version by using the =version= option:
  131. #+begin_src yaml
  132. monujo:
  133. options:
  134. version: 1.0.0-rc.1
  135. odoo:
  136. #+end_src
  137. If you don't want an active forcing on the version, you can set option
  138. =enforce-version= to =false=. This will ensure that whatever is already
  139. deployed in the internal directory, it won't be replaced by the charm
  140. on next =compose up=.
  141. #+begin_src yaml
  142. monujo:
  143. options:
  144. version: 1.0.0-rc.3
  145. enforce-version: false
  146. odoo:
  147. #+end_src