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:3d44fa6d3aac95017d846561060486eea62ab10c3a769965fd60efb1961da57f
375+ !! source digest: sha256:5062bdb51631430aaf2892a874377786dfe3f0fc40b0e058f744cca1f7ffeaaa
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/16.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-16-0/server-env-16-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=16.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/16.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-16-0/server-env-16-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=16.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
@@ -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 configuring
411416the incoming and outgoing mail servers depending on the environment.</ p >
@@ -416,7 +421,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
416421< tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > .</ p >
417422</ div >
418423< div class ="section " id ="configuration ">
419- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h1 >
424+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h2 >
420425< p > To configure this module, you need to edit the main configuration file
421426of your instance, and add a directive called < tt class ="docutils literal "> running_env</ tt > . Commonly
422427used values are ‘dev’, ‘test’, ‘production’:</ p >
@@ -433,7 +438,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
433438< p > If you don’t provide any value, < cite > test</ cite > is used as a safe default.</ p >
434439< p > You have several possibilities to set configuration values:</ p >
435440< div class ="section " id ="server-environment-files ">
436- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h2 >
441+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> server_environment_files</ a > </ h3 >
437442< p > You can edit the settings you need in the < tt class ="docutils literal "> server_environment_files</ tt > addon. The
438443< tt class ="docutils literal "> server_environment_files_sample</ tt > can be used as an example:</ p >
439444< ul class ="simple ">
@@ -446,7 +451,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">server_environment_files</a></h2>
446451</ ul >
447452</ div >
448453< div class ="section " id ="environment-variable ">
449- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h2 >
454+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Environment variable</ a > </ h3 >
450455< p > You can define configuration in the environment variable < tt class ="docutils literal "> SERVER_ENV_CONFIG</ tt >
451456and/or < tt class ="docutils literal "> SERVER_ENV_CONFIG_SECRET</ tt > . The 2 variables are handled the exact same
452457way, this is only a convenience for the deployment where you can isolate the
@@ -495,7 +500,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Environment variable</a></h2>
495500See “USAGE”.</ blockquote >
496501</ div >
497502< div class ="section " id ="default-values ">
498- < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h2 >
503+ < h3 > < a class ="toc-backref " href ="#toc-entry-5 "> Default values</ a > </ h3 >
499504< p > When using the < tt class ="docutils literal "> server.env.mixin</ tt > mixin, for each env-computed field, a
500505companion field < tt class ="docutils literal "> <field>_env_default</ tt > is created. This field is not
501506environment-dependent. It’s a fallback value used when no key is set in
@@ -504,12 +509,12 @@ <h2><a class="toc-backref" href="#toc-entry-5">Default values</a></h2>
504509< p > Note: empty environment keys always take precedence over default fields</ p >
505510</ div >
506511< div class ="section " id ="server-environment-integration ">
507- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h2 >
508- < p > Read the documentation of the class < a class ="reference external " href ="models/server_env_mixin.py "> models/server_env_mixin.py</ a > . </ p >
512+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Server environment integration</ a > </ h3 >
513+ < p > Read the documentation of the class < a class ="reference external " href ="models/server_env_mixin.py "> models/server_env_mixin.py</ a > and < a class =" reference external " href =" models/server_env_tech_name_mixin.py " > models/server_env_tech_name_mixin.py </ a > </ p >
509514</ div >
510515</ div >
511516< div class ="section " id ="usage ">
512- < h1 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h1 >
517+ < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Usage</ a > </ h2 >
513518< p > You can include a mixin in your model and configure the env-computed fields
514519by an override of < tt class ="docutils literal "> _server_env_fields</ tt > .</ p >
515520< pre class ="literal-block ">
@@ -526,13 +531,13 @@ <h1><a class="toc-backref" href="#toc-entry-7">Usage</a></h1>
526531< pre class ="literal-block ">
527532class StorageBackend(models.Model):
528533 _name = "storage.backend"
529- _inherit = ["storage.backend", "server.env.techname.mixin", "server.env.mixin" ]
534+ _inherit = ["storage.backend", "server.env.techname.mixin"]
530535
531536 [...]
532537</ pre >
533538</ div >
534539< div class ="section " id ="known-issues-roadmap ">
535- < h1 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h1 >
540+ < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Known issues / Roadmap</ a > </ h2 >
536541< ul class ="simple ">
537542< li > it is not possible to set the environment from the command line. A
538543configuration file must be used.</ li >
@@ -542,23 +547,23 @@ <h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
542547</ ul >
543548</ div >
544549< div class ="section " id ="bug-tracker ">
545- < h1 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h1 >
550+ < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> Bug Tracker</ a > </ h2 >
546551< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/server-env/issues "> GitHub Issues</ a > .
547552In case of trouble, please check there if your issue has already been reported.
548553If you spotted it first, help us to smash it by providing a detailed and welcomed
549554< a class ="reference external " href ="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
550555< p > Do not contact contributors directly about support or help with technical issues.</ p >
551556</ div >
552557< div class ="section " id ="credits ">
553- < h1 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h1 >
558+ < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> Credits</ a > </ h2 >
554559< div class ="section " id ="authors ">
555- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h2 >
560+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> Authors</ a > </ h3 >
556561< ul class ="simple ">
557562< li > Camptocamp</ li >
558563</ ul >
559564</ div >
560565< div class ="section " id ="contributors ">
561- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h2 >
566+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> Contributors</ a > </ h3 >
562567< ul class ="simple ">
563568< li > Florent Xicluna (Wingo) << a class ="reference external " href ="mailto:florent.xicluna@gmail.com "> florent.xicluna@gmail.com</ a > ></ li >
564569< li > Nicolas Bessi << a class ="reference external " href ="mailto:nicolas.bessi@camptocamp.com "> nicolas.bessi@camptocamp.com</ a > ></ li >
@@ -575,7 +580,7 @@ <h2><a class="toc-backref" href="#toc-entry-12">Contributors</a></h2>
575580</ ul >
576581</ div >
577582< div class ="section " id ="maintainers ">
578- < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h2 >
583+ < h3 > < a class ="toc-backref " href ="#toc-entry-13 "> Maintainers</ a > </ h3 >
579584< p > This module is maintained by the OCA.</ p >
580585< a class ="reference external image-reference " href ="https://odoo-community.org ">
581586< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -588,5 +593,6 @@ <h2><a class="toc-backref" href="#toc-entry-13">Maintainers</a></h2>
588593</ div >
589594</ div >
590595</ div >
596+ </ div >
591597</ body >
592598</ html >
0 commit comments