33< head >
44< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
55< meta name ="generator " content ="Docutils: https://docutils.sourceforge.io/ " />
6- < title > server configuration environment files </ title >
6+ < title > README.rst </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document " id ="server-configuration-environment-files ">
364- < h1 class ="title "> server configuration environment files</ h1 >
363+ < div class ="document ">
365364
365+
366+ < a class ="reference external image-reference " href ="https://odoo-community.org/get-involved?utm_source=readme ">
367+ < img alt ="Odoo Community Association " src ="https://odoo-community.org/readme-banner-image " />
368+ </ a >
369+ < div class ="section " id ="server-configuration-environment-files ">
370+ < h1 > server configuration environment files</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:39cd61c3a9621d0b7ee7a346adf45f4a2c90e80e6a61e18f182386c6fc90fd19
375+ !! source digest: sha256:4f9939b8b6cbb66e583bc8d6bde01be8551db8309fbb6ce18dc7ce65da46a5ec
371376!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372- < p > < a class ="reference external image-reference " href ="https://odoo-community.org/page/development-status "> < img alt ="Production/Stable " src ="https://img.shields.io/badge/maturity-Production%2FStable-green.png " /> </ a > < a class ="reference external image-reference " href ="http://www.gnu.org/licenses/lgpl-3.0-standalone.html "> < img alt ="License: LGPL-3 " src ="https://img.shields.io/badge/licence-LGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/server-env/tree/18.0/server_environment "> < img alt ="OCA/server-env " src ="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-server_environment "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
377+ < p > < a class ="reference external image-reference " href ="https://odoo-community.org/page/development-status "> < img alt ="Production/Stable " src ="https://img.shields.io/badge/maturity-Production%2FStable-green.png " /> </ a > < a class ="reference external image-reference " href ="http://www.gnu.org/licenses/lgpl-3.0-standalone.html "> < img alt ="License: LGPL-3 " src ="https://img.shields.io/badge/license-LGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/server-env/tree/18.0/server_environment "> < img alt ="OCA/server-env " src ="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-server_environment "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
373378< p > This module provides a way to define an environment in the main Odoo
374379configuration file and to read some configurations from files depending
375380on the configured environment: you define the environment in the main
@@ -405,7 +410,7 @@ <h1 class="title">server configuration environment files</h1>
405410</ ul >
406411</ div >
407412< div class ="section " id ="installation ">
408- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
413+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
409414< p > By itself, this module does little. See for instance the
410415< tt class ="docutils literal "> mail_environment</ tt > addon which depends on this one to allow
411416configuring the incoming and outgoing mail servers depending on the
@@ -417,7 +422,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
417422< tt class ="docutils literal "> SERVER_ENV_CONFIG</ tt > and < tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > .</ p >
418423</ div >
419424< div class ="section " id ="configuration ">
420- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h1 >
425+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h2 >
421426< p > To configure this module, you need to edit the main configuration file
422427of your instance, and add a directive called < tt class ="docutils literal "> running_env</ tt > . Commonly
423428used values are ‘dev’, ‘test’, ‘production’:</ p >
@@ -436,7 +441,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
436441< p > If you don’t provide any value, test is used as a safe default.</ p >
437442< p > You have several possibilities to set configuration values:</ p >
438443< div class ="section " id ="server-environment-files ">
439- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h2 >
444+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h3 >
440445< p > You can edit the settings you need in the < tt class ="docutils literal "> server_environment_files</ tt >
441446addon. The < tt class ="docutils literal "> server_environment_files_sample</ tt > can be used as an
442447example:</ p >
@@ -457,7 +462,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">server_environment_files</a></h2>
457462</ ul >
458463</ div >
459464< div class ="section " id ="environment-variable ">
460- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h2 >
465+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h3 >
461466< p > You can define configuration in the environment variable
462467< tt class ="docutils literal "> SERVER_ENV_CONFIG</ tt > and/or < tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > . The 2
463468variables are handled the exact same way, this is only a convenience for
@@ -507,7 +512,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Environment variable</a></h2>
507512reference records. See “USAGE”.</ blockquote >
508513</ div >
509514< div class ="section " id ="default-values ">
510- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h2 >
515+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h3 >
511516< p > When using the < tt class ="docutils literal "> server.env.mixin</ tt > mixin, for each env-computed field,
512517a companion field < tt class ="docutils literal "> <field>_env_default</ tt > is created. This field is not
513518environment-dependent. It’s a fallback value used when no key is set in
@@ -516,15 +521,15 @@ <h2><a class="toc-backref" href="#toc-entry-5">Default values</a></h2>
516521< p > Note: empty environment keys always take precedence over default fields</ p >
517522</ div >
518523< div class ="section " id ="server-environment-integration ">
519- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h2 >
524+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h3 >
520525< p > Read the documentation of the class
521526< a class ="reference external " href ="models/server_env_mixin.py "> models/server_env_mixin.py</ a > and
522527[models/server_env_tech_name_mixin.py]
523528(models/server_env_tech_name_mixin.py)</ p >
524529</ div >
525530</ div >
526531< div class ="section " id ="usage ">
527- < h1 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h1 >
532+ < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h2 >
528533< p > You can include a mixin in your model and configure the env-computed
529534fields by an override of < tt class ="docutils literal "> _server_env_fields</ tt > .</ p >
530535< pre class ="literal-block ">
@@ -548,7 +553,7 @@ <h1><a class="toc-backref" href="#toc-entry-7">Usage</a></h1>
548553</ pre >
549554</ div >
550555< div class ="section " id ="known-issues-roadmap ">
551- < h1 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h1 >
556+ < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h2 >
552557< ul class ="simple ">
553558< li > it is not possible to set the environment from the command line. A
554559configuration file must be used.</ li >
@@ -560,23 +565,23 @@ <h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
560565</ ul >
561566</ div >
562567< div class ="section " id ="bug-tracker ">
563- < h1 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h1 >
568+ < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h2 >
564569< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/server-env/issues "> GitHub Issues</ a > .
565570In case of trouble, please check there if your issue has already been reported.
566571If you spotted it first, help us to smash it by providing a detailed and welcomed
567572< a class ="reference external " href ="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
568573< p > Do not contact contributors directly about support or help with technical issues.</ p >
569574</ div >
570575< div class ="section " id ="credits ">
571- < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h1 >
576+ < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h2 >
572577< div class ="section " id ="authors ">
573- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h2 >
578+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h3 >
574579< ul class ="simple ">
575580< li > Camptocamp</ li >
576581</ ul >
577582</ div >
578583< div class ="section " id ="contributors ">
579- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h2 >
584+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h3 >
580585< ul class ="simple ">
581586< li > Florent Xicluna (Wingo) << a class ="reference external " href ="mailto:florent.xicluna@gmail.com "> florent.xicluna@gmail.com</ a > ></ li >
582587< li > Nicolas Bessi << a class ="reference external " href ="mailto:nicolas.bessi@camptocamp.com "> nicolas.bessi@camptocamp.com</ a > ></ li >
@@ -593,7 +598,7 @@ <h2><a class="toc-backref" href="#toc-entry-12">Contributors</a></h2>
593598</ ul >
594599</ div >
595600< div class ="section " id ="maintainers ">
596- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h2 >
601+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h3 >
597602< p > This module is maintained by the OCA.</ p >
598603< a class ="reference external image-reference " href ="https://odoo-community.org ">
599604< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -606,5 +611,6 @@ <h2><a class="toc-backref" href="#toc-entry-13">Maintainers</a></h2>
606611</ div >
607612</ div >
608613</ div >
614+ </ div >
609615</ body >
610616</ html >
0 commit comments