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:f0fd229f245a0b69ee443a25b9bb216df35eb548e0a24c580d807532d905ada2
375+ !! source digest: sha256:49cc54fa3804a8eede35b23ce7498be5f6baa6b6d2f0b1a5d3257aa84d519ab8
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/14.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-14-0/server-env-14-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=14.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/14.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-14-0/server-env-14-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=14.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
375380depending on the configured environment: you define the environment in
@@ -406,7 +411,7 @@ <h1 class="title">server configuration environment files</h1>
406411</ ul >
407412</ div >
408413< div class ="section " id ="installation ">
409- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
414+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
410415< p > By itself, this module does little. See for instance the
411416< tt class ="docutils literal "> mail_environment</ tt > addon which depends on this one to allow configuring
412417the incoming and outgoing mail servers depending on the environment.</ p >
@@ -417,7 +422,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
417422< 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 >
@@ -434,7 +439,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
434439< p > If you don’t provide any value, < cite > test</ cite > is used as a safe default.</ p >
435440< p > You have several possibilities to set configuration values:</ p >
436441< div class ="section " id ="server-environment-files ">
437- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h2 >
442+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h3 >
438443< p > You can edit the settings you need in the < tt class ="docutils literal "> server_environment_files</ tt > addon. The
439444< tt class ="docutils literal "> server_environment_files_sample</ tt > can be used as an example:</ p >
440445< ul class ="simple ">
@@ -453,7 +458,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">server_environment_files</a></h2>
453458</ ul >
454459</ div >
455460< div class ="section " id ="environment-variable ">
456- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h2 >
461+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h3 >
457462< p > You can define configuration in the environment variable < tt class ="docutils literal "> SERVER_ENV_CONFIG</ tt >
458463and/or < tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > . The 2 variables are handled the exact same
459464way, this is only a convenience for the deployment where you can isolate the
@@ -502,7 +507,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Environment variable</a></h2>
502507See “USAGE”.</ blockquote >
503508</ div >
504509< div class ="section " id ="default-values ">
505- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h2 >
510+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h3 >
506511< p > When using the < tt class ="docutils literal "> server.env.mixin</ tt > mixin, for each env-computed field, a
507512companion field < tt class ="docutils literal "> <field>_env_default</ tt > is created. This field is not
508513environment-dependent. It’s a fallback value used when no key is set in
@@ -511,12 +516,12 @@ <h2><a class="toc-backref" href="#toc-entry-5">Default values</a></h2>
511516< p > Note: empty environment keys always take precedence over default fields</ p >
512517</ div >
513518< div class ="section " id ="server-environment-integration ">
514- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h2 >
519+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h3 >
515520< p > Read the documentation of the class < a class ="reference external " href ="models/server_env_mixin.py "> models/server_env_mixin.py</ a > .</ p >
516521</ div >
517522</ div >
518523< div class ="section " id ="usage ">
519- < h1 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h1 >
524+ < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h2 >
520525< p > You can include a mixin in your model and configure the env-computed fields
521526by an override of < tt class ="docutils literal "> _server_env_fields</ tt > .</ p >
522527< 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 >
@@ -549,23 +554,23 @@ <h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
549554</ ul >
550555</ div >
551556< div class ="section " id ="bug-tracker ">
552- < h1 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h1 >
557+ < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h2 >
553558< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/server-env/issues "> GitHub Issues</ a > .
554559In case of trouble, please check there if your issue has already been reported.
555560If you spotted it first, help us to smash it by providing a detailed and welcomed
556561< a class ="reference external " href ="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
557562< p > Do not contact contributors directly about support or help with technical issues.</ p >
558563</ div >
559564< div class ="section " id ="credits ">
560- < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h1 >
565+ < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h2 >
561566< div class ="section " id ="authors ">
562- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h2 >
567+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h3 >
563568< ul class ="simple ">
564569< li > Camptocamp</ li >
565570</ ul >
566571</ div >
567572< div class ="section " id ="contributors ">
568- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h2 >
573+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h3 >
569574< ul class ="simple ">
570575< li > Florent Xicluna (Wingo) << a class ="reference external " href ="mailto:florent.xicluna@gmail.com "> florent.xicluna@gmail.com</ a > ></ li >
571576< li > Nicolas Bessi << a class ="reference external " href ="mailto:nicolas.bessi@camptocamp.com "> nicolas.bessi@camptocamp.com</ a > ></ li >
@@ -582,7 +587,7 @@ <h2><a class="toc-backref" href="#toc-entry-12">Contributors</a></h2>
582587</ ul >
583588</ div >
584589< div class ="section " id ="maintainers ">
585- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h2 >
590+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h3 >
586591< p > This module is maintained by the OCA.</ p >
587592< a class ="reference external image-reference " href ="https://odoo-community.org ">
588593< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -595,5 +600,6 @@ <h2><a class="toc-backref" href="#toc-entry-13">Maintainers</a></h2>
595600</ div >
596601</ div >
597602</ div >
603+ </ div >
598604</ body >
599605</ html >
0 commit comments