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:7942b4c462d2555dd0254b84b0db93bfc1e26fd3758582bbcdc2f73cc41958f2
375+ !! source digest: sha256:63b219d993d67edff4ef7cdfdb79606dce9435d848bf3c0e56252b4f5fd2d415
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 >
@@ -450,7 +455,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">server_environment_files</a></h2>
450455</ ul >
451456</ div >
452457< div class ="section " id ="environment-variable ">
453- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h2 >
458+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h3 >
454459< p > You can define configuration in the environment variable
455460< tt class ="docutils literal "> SERVER_ENV_CONFIG</ tt > and/or < tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > . The 2
456461variables are handled the exact same way, this is only a convenience for
@@ -500,7 +505,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Environment variable</a></h2>
500505reference records. See “USAGE”.</ blockquote >
501506</ div >
502507< div class ="section " id ="default-values ">
503- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h2 >
508+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h3 >
504509< p > When using the < tt class ="docutils literal "> server.env.mixin</ tt > mixin, for each env-computed field,
505510a companion field < tt class ="docutils literal "> <field>_env_default</ tt > is created. This field is not
506511environment-dependent. It’s a fallback value used when no key is set in
@@ -509,13 +514,13 @@ <h2><a class="toc-backref" href="#toc-entry-5">Default values</a></h2>
509514< p > Note: empty environment keys always take precedence over default fields</ p >
510515</ div >
511516< div class ="section " id ="server-environment-integration ">
512- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h2 >
517+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h3 >
513518< p > Read the documentation of the class
514519< a class ="reference external " href ="models/server_env_mixin.py "> models/server_env_mixin.py</ a > .</ p >
515520</ div >
516521</ div >
517522< div class ="section " id ="usage ">
518- < h1 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h1 >
523+ < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h2 >
519524< p > You can include a mixin in your model and configure the env-computed
520525fields by an override of < tt class ="docutils literal "> _server_env_fields</ tt > .</ p >
521526< pre class ="literal-block ">
@@ -539,7 +544,7 @@ <h1><a class="toc-backref" href="#toc-entry-7">Usage</a></h1>
539544</ pre >
540545</ div >
541546< div class ="section " id ="known-issues-roadmap ">
542- < h1 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h1 >
547+ < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h2 >
543548< ul class ="simple ">
544549< li > it is not possible to set the environment from the command line. A
545550configuration file must be used.</ li >
@@ -551,23 +556,23 @@ <h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
551556</ ul >
552557</ div >
553558< div class ="section " id ="bug-tracker ">
554- < h1 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h1 >
559+ < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h2 >
555560< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/server-env/issues "> GitHub Issues</ a > .
556561In case of trouble, please check there if your issue has already been reported.
557562If you spotted it first, help us to smash it by providing a detailed and welcomed
558563< 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 >
559564< p > Do not contact contributors directly about support or help with technical issues.</ p >
560565</ div >
561566< div class ="section " id ="credits ">
562- < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h1 >
567+ < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h2 >
563568< div class ="section " id ="authors ">
564- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h2 >
569+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h3 >
565570< ul class ="simple ">
566571< li > Camptocamp</ li >
567572</ ul >
568573</ div >
569574< div class ="section " id ="contributors ">
570- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h2 >
575+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h3 >
571576< ul class ="simple ">
572577< li > Florent Xicluna (Wingo) << a class ="reference external " href ="mailto:florent.xicluna@gmail.com "> florent.xicluna@gmail.com</ a > ></ li >
573578< li > Nicolas Bessi << a class ="reference external " href ="mailto:nicolas.bessi@camptocamp.com "> nicolas.bessi@camptocamp.com</ a > ></ li >
@@ -584,7 +589,7 @@ <h2><a class="toc-backref" href="#toc-entry-12">Contributors</a></h2>
584589</ ul >
585590</ div >
586591< div class ="section " id ="maintainers ">
587- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h2 >
592+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h3 >
588593< p > This module is maintained by the OCA.</ p >
589594< a class ="reference external image-reference " href ="https://odoo-community.org ">
590595< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -597,5 +602,6 @@ <h2><a class="toc-backref" href="#toc-entry-13">Maintainers</a></h2>
597602</ div >
598603</ div >
599604</ div >
605+ </ div >
600606</ body >
601607</ html >
0 commit comments