# odoo-simple-docker

**Repository Path**: slacrey/odoo-simple-docker

## Basic Information

- **Project Name**: odoo-simple-docker
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-07
- **Last Updated**: 2022-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

docker run -p 8069:8069 --name odoo --link db:db -t slacrey/simple:e15.0
# How to use this image
This image requires a running PostgreSQL server.

## Start a PostgreSQL server
```
$ docker run -d -e POSTGRES_USER=odoo -e POSTGRES_PASSWORD=odoo -e POSTGRES_DB=postgres --name db postgres:13
```

## Start an Odoo instance

```
$ docker run -p 8069:8069 --name odoo --link db:db -t slacrey/simple
```

The alias of the container running Postgres must be db for Odoo to be able to connect to the Postgres server.

## Stop and restart an Odoo instance
```
$ docker stop odoo
$ docker start -a odoo
```

## Use named volumes to preserve data
When the Odoo container is created like described above, the odoo filestore is created inside the container. If the container is removed, the filestore is lost. The preferred way to prevent that is by using a Docker named volume.

```
$ docker run -v odoo-data:/var/lib/odoo -d -p 8069:8069 --name odoo --link db:db -t slacrey/simple
```

With the above command, the volume named odoo-data will persist even if the container is removed and can be re-used by issuing the same command.

The path ```/var/lib/odoo``` used as the mount point of the volume must match the odoo data_dir in the config file or as CLI parameters.

Note that the same principle applies to the Postgresql container and a named volume can be used to preserve the database when the container is removed. So the database container could be started like this (before the odoo container):

```
$ docker run -d -v odoo-db:/var/lib/postgresql/data -e POSTGRES_USER=odoo -e POSTGRES_PASSWORD=odoo -e POSTGRES_DB=postgres --name db postgres:13
```


## Stop and restart a PostgreSQL server
When a PostgreSQL server is restarted, the Odoo instances linked to that server must be restarted as well because the server address has changed and the link is thus broken.

Restarting a PostgreSQL server does not affect the created databases.

## Run Odoo with a custom configuration

The default configuration file for the server (located at ```/etc/odoo/odoo.conf```) can be overriden at startup using volumes. Suppose you have a custom configuration at ```/path/to/config/odoo.conf```, then

```
$ docker run -v /path/to/config:/etc/odoo -p 8069:8069 --name odoo --link db:db -t slacrey/simple
```

Please use [this configuration template](https://gitee.com/slacrey/odoo-simple-docker/blob/master/15.0/odoo.conf) to write your custom configuration as we already set some arguments for running Odoo inside a Docker container.

You can also directly specify Odoo arguments inline. Those arguments must be given after the keyword -- in the command-line, as follows

```
$ docker run -p 8069:8069 --name odoo --link db:db -t slacrey/simple -- --db-filter=odoo_db_.*
```

## Mount custom addons

You can mount your own Odoo addons within the Odoo container, at ```/mnt/extra-addons```

```
$ docker run -v /path/to/addons:/mnt/extra-addons -p 8069:8069 --name odoo --link db:db -t slacrey/simple
```


# Run multiple Odoo instances
```
$ docker run -p 8070:8069 --name odoo2 --link db:db -t slacrey/simple
$ docker run -p 8071:8069 --name odoo3 --link db:db -t slacrey/simple
```

Please note that for plain use of mails and reports functionalities, when the host and container ports differ (e.g. 8070 and 8069), one has to set, in Odoo, Settings->Parameters->System Parameters (requires technical features), web.base.url to the container port (e.g. 127.0.0.1:8069).


# Environment Variables

Tweak these environment variables to easily connect to a postgres server:

- ```HOST```: The address of the postgres server. If you used a postgres container, set to the name of the container. Defaults to db.
- ```PORT```: The port the postgres server is listening to. Defaults to 5432.
- ```USER```: The postgres role with which Odoo will connect. If you used a postgres container, set to the same value as POSTGRES_USER. Defaults to odoo.
- ```PASSWORD```: The password of the postgres role with which Odoo will connect. If you used a postgres container, set to the same value as POSTGRES_PASSWORD. Defaults to odoo.


# Docker Compose examples

If the default postgres credentials does not suit you, tweak the environment variables:

```
version: '3.1'
services:
  web:
    image: slacrey/simple:15.0
    depends_on:
      - mydb
    ports:
      - "8069:8069"
    environment:
    - HOST=mydb
    - USER=odoo
    - PASSWORD=myodoo
  mydb:
    image: postgres:13
    environment:
      - POSTGRES_DB=postgres
      - POSTGRES_PASSWORD=myodoo
      - POSTGRES_USER=odoo
```

Here's a last example showing you how to

mount custom addons located in ```./addons```
- use a custom configuration file located in ```.config/odoo.conf```
- use named volumes for the Odoo and postgres data dir
- use a secrets file named odoo_pg_pass that contains the postgreql password shared by both services

```
version: '3.1'
services:
  web:
    image: slacrey/simple:15.0
    depends_on:
      - db
    ports:
      - "8069:8069"
    volumes:
      - odoo-web-data:/var/lib/odoo
      - ./config:/etc/odoo
      - ./addons:/mnt/extra-addons
    environment:
      - PASSWORD_FILE=/run/secrets/postgresql_password
    secrets:
      - postgresql_password
  db:
    image: postgres:13
    environment:
      - POSTGRES_DB=postgres
      - POSTGRES_PASSWORD_FILE=/run/secrets/postgresql_password
      - POSTGRES_USER=odoo
      - PGDATA=/var/lib/postgresql/data/pgdata
    volumes:
      - odoo-db-data:/var/lib/postgresql/data/pgdata
    secrets:
      - postgresql_password
volumes:
  odoo-web-data:
  odoo-db-data:

secrets:
  postgresql_password:
    file: odoo_pg_pass
```