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

Update README, clarify public features #20

Merged
merged 1 commit into from
Feb 21, 2023
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
40 changes: 24 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Odoo Bedrock container image
============================

``/!\ this is alpha stuff, use at your own risk, expect things to change /!\``

This image is meant as a greatest common denominator foundation to run Odoo.

It is a BYOO (bring-your-own-odoo) image, which means you need
Expand All @@ -14,8 +12,12 @@ structure.

.. contents::

Features
========
Features exposed by these images
================================

.. note::

Anything not documented here considered implementation detail and may change.

* Ubuntu minimal because it's small and has recent pythons

Expand All @@ -24,15 +26,14 @@ Features
* 18.04 for Odoo <= 13 images

* ``python``, obviously.
* `confd <https://github.com/kelseyhightower/confd>`_ to generate
the Odoo configuration file from environment variables or any other source
* `gosu <https://github.com/tianon/gosu>`_ to step down from root in the entrypoint
* ``nano``, ``less``, for some rudimentary comfort when the time comes to investigate
the container on the terminal
* An entrypoint that generates the Odoo config file (``$ODOO_RC``) from environment
variables (see the list of supported variables below).
* ``/usr/local/bin/wkhtmltopdf`` is the `kwkhtmltopdf
<https://github.com/acsone/kwkhtmltopdf>`_ client. The default
KWKHTMLTOPDF_SERVER_URL environment variable is set to http://kwkhtmltopdf.
* Odoo mandatory external dependencies (i.e. ``lessc`` for Odoo < 12)
* ``nano``, ``less``, for some rudimentary comfort when the time comes to investigate
the container on the terminal
* postgres `apt repo <https://wiki.postgresql.org/wiki/Apt>`_ for easy installation
of the latest postgres client tools if needed

Expand All @@ -47,17 +48,24 @@ versions.

The entrypoint does the following:

* confd + gosu, `mostly <./bin/entrypoint.sh>`_.
* run scripts in /odoo/start-entrypoint.d/
* Generate the ``$ODOO_RC`` file from environment variables
* If the command looks like odoo, run scripts in ``/odoo/start-entrypoint.d/``.
* Unless ``$NOGOSU`` is set, run the entry point scripts, as well as the command, under
user ``$LOCAL_USER_ID`` (defaults to 999).

Configuration
=============
For more details, read `./bin/entrypoint.sh <./bin/entrypoint.sh>`_.

TBC
Configuration
~~~~~~~~~~~~~

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

* ``DB_HOST``, ``DB_USER``, ``DB_PASSWORD``, ``DB_NAME``
* ``DB_HOST``
* ``DB_USER``
* ``DB_PASSWORD``
* ``DB_NAME``
* ... TODO

Examples
========
Expand Down