Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs a little bit #44

Merged
merged 2 commits into from
Nov 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,13 @@ a derived image that adds your Odoo and addons. This image does not
mandate any particular installation method for Odoo and addons, nor does
it impose any constraint on your project structure.

<div class="contents">

</div>

## Available image tags

The CI of this project builds regularly for some combinations of Odoo
version, python version and Ubuntu version.

The supported combinations are visible in the \[build
matrix\](./.github/workflows/ci.yml).
The supported combinations are visible in the [build
matrix](./.github/workflows/ci.yml).

## Features exposed by these images

Expand Down Expand Up @@ -62,9 +58,10 @@ For more details, read [./bin/entrypoint.sh](./bin/entrypoint.sh).
### Configuration

The following environment variables are used to generate the Odoo
configuration file in `$ODOO_RC`:
configuration file in `$ODOO_RC`.

Odoo options:

- `ADDITIONAL_ODOO_RC`
- `ADDONS_PATH`
- `ADMIN_PASSWD`
- `DB_FILTER`
Expand Down Expand Up @@ -93,13 +90,18 @@ configuration file in `$ODOO_RC`:
- `LOG_LEVEL`
- `LOGFILE`
- `MAX_CRON_THREADS`
- `RUNNING_ENV`
- `SERVER_WIDE_MODULES` (\>=10)
- `SYSLOG`
- `UNACCENT`
- `WITHOUT_DEMO`
- `WORKERS`

Other variables that populate `$ODOO_RC`:

- `RUNNING_ENV`: sets `options.running_env` for use by the [OCA
server_environment](https://github.com/OCA/server-env) module.
- `ADDITIONAL_ODOO_RC`: is appended verbatim a the end of `$ODOO_RC˘.

The following environment variables are processed by the entrypoint, if
the psql client is installed (which is not the case by default):

Expand All @@ -115,7 +117,7 @@ inspiration.
Assume you have your custom addons in `myaddons`. You can create the
following Dockerfile:

``` dockerfile
```dockerfile
ARG odoo_version=17.0

###########################################################################
Expand Down