Bitnami Docker Image for Odoo

What is Odoo?

Odoo is a suite of web based open source business apps. Odoo Apps can be used as stand-alone applications, but they also integrate seamlessly so you get a full-featured Open Source ERP when you install several Apps.

https://odoo.com/

TL;DR

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-odoo/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Environment Variables section for a more secure deployment.

Why use Bitnami Images?

Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
With Bitnami images the latest bug fixes and features are available as soon as possible.
Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use DOCKER_CONTENT_TRUST=1 to verify the integrity of the images.
Bitnami container images are released daily with the latest distribution packages available.

This CVE scan report contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.

How to deploy Odoo in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Odoo Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Supported tags and respective `Dockerfile` links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.

Subscribe to project updates by watching the bitnami/odoo GitHub repo.

Get this image

The recommended way to get the Bitnami Odoo Docker Image is to pull the prebuilt image from the Docker Hub Registry.

$ docker pull bitnami/odoo:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

$ docker pull bitnami/odoo:[TAG]

If you wish, you can also build the image yourself.

$ docker build -t bitnami/odoo:latest 'https://github.com/bitnami/bitnami-docker-odoo.git#master:14/debian-10'

How to use this image

Odoo requires access to a PostgreSQL database to store information. We'll use the Bitnami Docker Image for PostgreSQL for the database requirements.

Run the application using Docker Compose

The main folder of this repository contains a functional docker-compose.yml file. Run the application using it as shown below:

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-odoo/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

Step 1: Create a network

$ docker network create odoo-network

Step 2: Create a volume for PostgreSQL persistence and create a PostgreSQL container

$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env POSTGRESQL_PASSWORD=bitnami \
  --network odoo-network \
  --volume postgresql_data:/bitnami/postgresql \
  bitnami/postgresql:latest

Step 3: Create volumes for Odoo persistence and launch the container

$ docker volume create --name odoo_data
$ docker run -d --name odoo \
  -p 80:8069 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env ODOO_DATABASE_ADMIN_PASSWORD=bitnami \
  --network odoo-network \
  --volume odoo_data:/bitnami/odoo \
  bitnami/odoo:latest

Access your application at http://your-ip/

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami/odoo path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should mount a volume for persistence of the PostgreSQL data.

The above examples define the Docker volumes named postgresql_data and odoo_data. The Odoo application state will persist as long as volumes are not removed.

To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml file present in this repository:

   postgresql:
     ...
     volumes:
-      - 'postgresql_data:/bitnami/postgresql'
+      - /path/to/postgresql-persistence:/bitnami/postgresql
   ...
   odoo:
     ...
     volumes:
-      - 'odoo_data:/bitnami/odoo'
+      - /path/to/odoo-persistence:/bitnami/odoo
   ...
-volumes:
-  postgresql_data:
-    driver: local
-  odoo_data:
-    driver: local

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Mount host directories as data volumes using the Docker command line

Step 1: Create a network (if it does not exist)

$ docker network create odoo-network

Step 2. Create a PostgreSQL container with host volume

$ docker run -d --name postgresql \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env POSTGRESQL_PASSWORD=bitnami \
  --network odoo-network \
  --volume /path/to/postgresql-persistence:/bitnami/postgresql \
  bitnami/postgresql:latest

Step 3. Create the Odoo container with host volumes

$ docker run -d --name odoo \
  -p 80:8069 \
  --env ALLOW_EMPTY_PASSWORD=yes \
  --env ODOO_DATABASE_ADMIN_PASSWORD=bitnami \
  --network odoo-network \
  --volume /path/to/odoo-persistence:/bitnami/odoo \
  bitnami/odoo:latest

Configuration

Environment variables

When you start the Odoo image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

For docker-compose add the variable name and value under the application section in the docker-compose.yml file present in this repository:
```
odoo:
  ...
  environment:
    - ODOO_PASSWORD=my_password
  ...
```

For manual execution add a --env option with each variable and value:

$ docker run -d --name odoo -p 80:8069 \
  --env ODOO_PASSWORD=my_password \
  --network odoo-tier \
  --volume /path/to/odoo-persistence:/bitnami \
  bitnami/odoo:latest

Available environment variables:

User and Site configuration

ODOO_EMAIL: Odoo application email. Default: user@example.com
ODOO_PASSWORD: Odoo application password. Default: bitnami
ODOO_SKIP_BOOTSTRAP: Whether to skip performing the initial bootstrapping for the application. This is necessary in case you use a database that already has Odoo data. Default: no
ODOO_SKIP_MODULES_UPDATE: Whether to perform initial update of the plugins installed. Default: no
ODOO_LOAD_DEMO_DATA: Whether to load demo data. Default: yes

Database connection configuration

ODOO_DATABASE_HOST: Hostname for PostgreSQL server. Default: postgresql
ODOO_DATABASE_PORT_NUMBER: Port used by the PostgreSQL server. Default: 5432
ODOO_DATABASE_ADMIN_USER: Database admin user that Odoo will use to connect with the database. Default: postgres
ODOO_DATABASE_ADMIN_PASSWORD: Database admin password that Odoo will use to connect with the database. No default.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

Create a database for Odoo using postgresql-client

POSTGRESQL_CLIENT_DATABASE_HOST: Hostname for the PostgreSQL server. Default: postgresql
POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER: Port used by the PostgreSQL server. Default: 5432
POSTGRESQL_CLIENT_POSTGRES_USER: Database admin user. Default: root
POSTGRESQL_CLIENT_POSTGRES_PASSWORD: Database password for the database admin user. No default.
POSTGRESQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No default.
POSTGRESQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No default.
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the POSTGRESQL_CLIENT_CREATE_DATABASE_USER user. No default.
POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS: PostgreSQL extensions to enable in the specified database during the first initialization. No default.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

SMTP Configuration

To configure Odoo to send email using SMTP you can set the following environment variables:

ODOO_SMTP_HOST: SMTP host.
ODOO_SMTP_PORT_NUMBER: SMTP port.
ODOO_SMTP_USER: SMTP account user.
ODOO_SMTP_PASSWORD: SMTP account password.
ODOO_SMTP_PROTOCOL: If specified, SMTP protocol to use. Allowed values: tls, ssl. No default.

Examples

SMTP configuration using a Gmail account

This would be an example of SMTP configuration using a Gmail account:

Modify the docker-compose.yml file present in this repository:

  odoo:
    ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - ODOO_SMTP_HOST=smtp.gmail.com
      - ODOO_SMTP_PORT_NUMBER=587
      - ODOO_SMTP_USER=your_email@gmail.com
      - ODOO_SMTP_PASSWORD=your_password
  ...

For manual execution:

$ docker run -d --name odoo -p 80:8069 \
  --env ODOO_SMTP_HOST=smtp.gmail.com \
  --env ODOO_SMTP_PORT_NUMBER=587 \
  --env ODOO_SMTP_USER=your_email@gmail.com \
  --env ODOO_SMTP_PASSWORD=your_password \
  --network odoo-tier \
  --volume /path/to/odoo-persistence:/bitnami \
  bitnami/odoo:latest

Connect Odoo container to an existing database

The Bitnami Odoo container supports connecting the Odoo application to an external database. This would be an example of using an external database for Odoo.

Modify the docker-compose.yml file present in this repository:

   odoo:
     ...
     environment:
-      - ODOO_DATABASE_HOST=mariadb
+      - ODOO_DATABASE_HOST=mariadb_host
       - ODOO_DATABASE_PORT_NUMBER=3306
-      - ALLOW_EMPTY_PASSWORD=yes
+      - ODOO_DATABASE_ADMIN_PASSWORD=odoo_password
     ...

For manual execution:

$ docker run -d --name odoo\
  -p 80:8069 \
  --network odoo-network \
  --env ODOO_DATABASE_HOST=mariadb_host \
  --env ODOO_DATABASE_PORT_NUMBER=3306 \
  --env ODOO_DATABASE_ADMIN_PASSWORD=odoo_password \
  --volume odoo_data:/bitnami/odoo \
  bitnami/odoo:latest

In case the database already contains data from a previous Odoo installation, you need to set the variable ODOO_SKIP_BOOTSTRAP to yes. Otherwise, the container would execute the installation wizard and could modify the existing data in the database. Note that, when setting ODOO_SKIP_BOOTSTRAP to yes, values for environment variables such as ODOO_EMAIL or ODOO_PASSWORD will be ignored.

Logging

The Bitnami Odoo Docker image sends the container logs to stdout. To view the logs:

$ docker logs odoo

Or using Docker Compose:

$ docker-compose logs odoo

You can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Backing up your container

To backup your data, configuration and logs, follow these simple steps:

Step 1: Stop the currently running container

$ docker stop odoo

Or using Docker Compose:

$ docker-compose stop odoo

Step 2: Run the backup command

We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.

$ docker run --rm -v /path/to/odoo-backups:/backups --volumes-from odoo busybox \
  cp -a /bitnami/odoo /backups/latest

Restoring a backup

Restoring a backup is as simple as mounting the backup as volumes in the containers.

For the PostgreSQL database container:

 $ docker run -d --name postgresql \
   ...
-  --volume /path/to/postgresql-persistence:/bitnami/postgresql \
+  --volume /path/to/postgresql-backups/latest:/bitnami/postgresql \
   bitnami/postgresql:latest

For the Odoo container:

 $ docker run -d --name odoo \
   ...
-  --volume /path/to/odoo-persistence:/bitnami/odoo \
+  --volume /path/to/odoo-backups/latest:/bitnami/odoo \
   bitnami/odoo:latest

Upgrade this image

Bitnami provides up-to-date versions of PostgreSQL and Odoo, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Odoo container. For the PostgreSQL upgrade see: https://github.com/bitnami/bitnami-docker-postgresql/blob/master/README.md#upgrade-this-image

The bitnami/odoo:latest tag always points to the most recent release. To get the most recent release you can simple repull the latest tag from the Docker Hub with docker pull bitnami/odoo:latest. However it is recommended to use tagged versions.

Step 1: Get the updated image

$ docker pull bitnami/odoo:latest

Step 2: Stop the running container

Stop the currently running container using the command

$ docker-compose stop odoo

Step 3: Take a snapshot of the application state

Follow the steps in Backing up your container to take a snapshot of the current application state.

Step 4: Remove the currently running container

Remove the currently running container by executing the following command:

docker-compose rm -v odoo

Step 5: Run the new image

Update the image tag in docker-compose.yml and re-create your container with the new image:

$ docker-compose up -d

Notable Changes

12.0.20210615-debian-10-r20, 13.0.20210610-debian-10-r24 and 14.0.20210610-debian-10-r22

The size of the container image has been decreased.
The configuration logic is now based on Bash scripts in the rootfs/ folder.
It is now possible to use an already populated Odoo database from another installation. In order to do this, use the environment variable ODOO_SKIP_BOOTSTRAP, which forces the container not to run the initial Odoo setup wizard.
Removed port 8071 from list of exposed ports. This port was used by the Odoo XMLRPCS service, but was removed in Odoo 10.
Added port 8072 to the list of exposed ports. This port is used by the Odoo Longpolling service.
The WITHOUT_DEMO environment variable was deprecated in favor of the boolean ODOO_LOAD_DEMO_DATA environment variable.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

Host OS and version
Docker version (docker version)
Output of docker info
Version of this container
The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.