Skip to content

Commit

Permalink
docs: local development
Browse files Browse the repository at this point in the history
  • Loading branch information
rubencabrera committed Jul 5, 2024
1 parent 7508d09 commit cf7e06d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,22 @@ config (see section below, look at `DB_FILTER` especially for local
development).
1. Run `docker-compose up` in the root path.

### Developing using this image

With the provided `docker-compose.yml`, all the repos will be in the code
volume, named using the environment variable `$ODOO_DOCKER_PROJECT_NAME`
(with a default value of `odoo_docker`).

The docker compose volume with the code configured in the given
`docker-compose.yml` will need an existing **empty** directory where the repos
will be cloned. The default path is
`${HOME}/.${ODOO_DOCKER_PROJECT_NAME}_repos` and can be overriden by setting
the `$ODOO_DOCKER_REPOS_HOST_PATH` (to an existing empty directory) before
running `docker-compose up`.

The repos are all cloned using git with `--depth=1`, so can be worked as any
other git repo.

## Odoo server config using environment variables

Odoo uses a config file that is a bit of a pain with a docker
Expand Down
3 changes: 2 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ services:
condition: service_healthy
restart: true
environment:
# FIXME: might want to remove this for prod.
- DB_FILTER=.*
image: "rubencabrera/odoo-docker:16.1.0"
image: "rubencabrera/odoo-docker:16.1.1"
ports:
- "8069:8069"
- "8071:8071"
Expand Down

0 comments on commit cf7e06d

Please sign in to comment.