Odoo

https://www.odoo.com/documentation/saas-19.1
Admin
Odoo is an all-in-one business management software suite that includes a wide range of applications...
Tokens:804,040
Snippets:12,283
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Debian/Ubuntu System Dependencies

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/source.html

Installs required system packages on Debian/Ubuntu using the setup script.

```bash
cd odoo #CommunityPath
sudo ./setup/debinstall.sh

```

--------------------------------

### Install PostgreSQL on Fedora

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/packages.html

Installs and configures the PostgreSQL server on Fedora systems. Enables and starts the PostgreSQL service.

```bash
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql

```

--------------------------------

### Install Odoo from downloaded package on Fedora

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/packages.html

Installs Odoo from a downloaded .rpm package on Fedora using dnf. Enables and starts the Odoo service.

```bash
$ sudo dnf localinstall odoo_19.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo

```

--------------------------------

### Guide Through Menus with menuselection

Source: https://www.odoo.com/documentation/saas-19.1/contributing/documentation/rst_guidelines.html

Use the `menuselection` markup to guide users through a sequence of menus, starting with the app's name. Ensure only actual menu items are included.

```rst
To review sales performance, go to :menuselection:`Sales --> Reporting --> Dashboard`.
```

```rst
To configure the bill control policy, navigate to :menuselection:`Purchase --> Configuration
--> Settings`, and scroll down to the :guilabel:`Invoicing` section. Under :guilabel:`Bill
Control`, select either :guilabel:`Ordered quantities` or :guilabel:`Received quantities`.
```

--------------------------------

### Install PostgreSQL on Linux

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/source.html

Install PostgreSQL and its client using the apt package manager.

```bash
$ sudo apt install postgresql postgresql-client

```

--------------------------------

### Install Upgrade utils via pip

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/upgrades/upgrade_utils.html

Install the library directly from the GitHub repository using pip.

```bash
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
```

--------------------------------

### Example Alert Block

Source: https://www.odoo.com/documentation/saas-19.1/contributing/documentation/rst_guidelines.html

Use the `example` alert block to show an example.

```rst
.. example::
   Use this alert block to show an example.
```

--------------------------------

### Install PostgreSQL on Debian/Ubuntu

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/packages.html

Installs the PostgreSQL server on Debian-based systems. Ensure sudo is configured.

```bash
$ sudo apt install postgresql -y

```

--------------------------------

### Install macOS Command Line Tools

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/source.html

Installs the necessary command line tools on macOS.

```bash
xcode-select --install

```

--------------------------------

### Initialize a Database

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/cli.html

Creates a new database and installs the base module.

```bash
$ odoo-bin db init <database>
```

--------------------------------

### Clone the tutorials repository

Source: https://www.odoo.com/documentation/saas-19.1/developer/tutorials/setup_guide.html

Download the tutorials repository to your local machine to begin working on tutorial modules.

```bash
$ git clone git@github.com:odoo/tutorials.git
```

--------------------------------

### Odoo command line help and demo data installation

Source: https://www.odoo.com/documentation/saas-19.1/developer/tutorials/define_module_data.html

Displays the help menu for the Odoo binary and demonstrates how to initialize a database with demo data enabled.

```bash
$ ./odoo-bin -h
Usage: odoo-bin [options]

Options:
--version             show program's version number and exit
-h, --help            show this help message and exit

Common options:
  [...]
  --with-demo         install demo data in new databases
[...]

$ ./odoo-bin --addons-path=... -d new-db -i base --with-demo
```

--------------------------------

### Add Odoo Repository and Install on Fedora

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/packages.html

Adds the Odoo nightly repository and installs the Odoo Community edition. Enables and starts the Odoo service.

```bash
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/19.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo

```

--------------------------------

### Open Customers with List and Form Views

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/backend/actions.html

Example of a window action configuration in JSON to display partners with the customer flag set.

```json
{
    "type": "ir.actions.act_window",
    "res_model": "res.partner",
    "views": [[False, "list"], [False, "form"]],
    "domain": [["customer", "=", true]],
}
```

--------------------------------

### Sample Configuration File

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/cli.html

Example of the [options] section in an Odoo configuration file.

```ini
[options]
db_user=odoo
dbfilter=odoo
```

--------------------------------

### Nginx Root and Try_files for Git Source Installation

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/deploy.html

Example `root` and `try_files` directives for Nginx when Odoo is installed from Git sources. This configuration accounts for multiple addons paths.

```nginx
root /opt/odoo;
try_files /community/odoo/addons$uri /community/addons$uri /enterprise$uri @odoo;
```

--------------------------------

### Install Make (Linux)

Source: https://www.odoo.com/documentation/saas-19.1/contributing/documentation.html

Install the 'make' utility on Debian-based Linux distributions using apt. This tool is often used for automating build processes.

```bash
$ sudo apt install make -y

```

--------------------------------

### Nginx Root and Try_files for Debian Package Installation

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/deploy.html

Example `root` and `try_files` directives for Nginx when Odoo is installed via Debian packages. This assumes a specific `--addons-path`.

```nginx
root /usr/lib/python3/dist-packages/odoo/addons;
try_files $uri @odoo;
```

--------------------------------

### Get Start of Time Period

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/backend/orm.html

Use `_start_of()` to calculate the start of a specified time period (year, quarter, month, week, day, hour) from a given date or datetime.

```python
fields.Date._start_of(value, granularity='month')
```

--------------------------------

### CSS Property Ordering

Source: https://www.odoo.com/documentation/saas-19.1/contributing/development/coding_guidelines.html

Example showing the required order of properties, starting with variables and positioning, followed by layout and decorative rules.

```scss
.o_element {
   $-inner-gap: $border-width + $legend-margin-bottom;

   --element-margin: 1rem;
   --element-size: 3rem;

   @include o-position-absolute(1rem);
   display: block;
   margin: var(--element-margin);
   width: calc(var(--element-size) + #{$-inner-gap});
   border: 0;
   padding: 1rem;
   background: blue;
   font-size: 1rem;
   filter: blur(2px);
}
```

--------------------------------

### Adjust Margin in ZPL Label

Source: https://www.odoo.com/documentation/saas-19.1/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/zebra.html

Modify the ^FT command to change the starting position of text or graphics. This example shifts the x-coordinate from 100 to 0 to prevent product names from being cut off.

```ZPL
^XA^CI28
^FT100,80^A0N,40,30^FD[E-COM11] Cabinet with Doors (wood: Cherry, handles: brass)^FS
...
^XZ

```

```ZPL
^XA^CI28
^FT0,80^A0N,40,30^FD[E-COM11] Cabinet with Doors (wood: Cherry, handles: brass)^FS
...
^XZ

```

--------------------------------

### Supported Native Module Imports and Exports

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/frontend/javascript_modules.html

These examples show the syntax for `import` and `export` keywords that are supported by Odoo's native module system. Ensure `import` or `export` are not preceded by non-space characters and that multiline comments do not start with these keywords.

```javascript
// supported
import X from "xxx";
export X;
  export default X;
    import X from "xxx";

/*
 * import X ...
 */

/*
 * export X
 */
```

--------------------------------

### Onboarding Tour File Structure

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/backend/testing.html

Standard directory layout for organizing onboarding tour files within a module.

```text
your_module
├── ...
├── data
|   └── your_tour.xml
├── static/src/js/tours/your_tour.js
└── __manifest__.py
```

--------------------------------

### Unsupported Native Module Imports and Exports

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/frontend/javascript_modules.html

These examples illustrate `import` and `export` syntax that is not supported by Odoo's native module system due to parsing limitations. Avoid starting lines with `import` or `export` after non-space characters or within multiline comments.

```javascript
// not supported

var a= 1;import X from "xxx";
/*
  import X ...
*/
```

--------------------------------

### Launch Odoo Server

Source: https://www.odoo.com/documentation/saas-19.1/developer/tutorials/setup_guide.html

Start the Odoo server using the odoo-bin command with specified addons paths and database.

```bash
$ cd $HOME/src/odoo/
$ ./odoo-bin --addons-path="addons/,../enterprise/,../tutorials" -d rd-demo
```

--------------------------------

### POST /start

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/external_rpc_api.html

Requests a new test database instance from the Odoo demo server.

```APIDOC
## XML-RPC: start

### Description
Requests a test database from the Odoo demo server. Returns connection details including host, database name, username, and password.

### Endpoint
https://demo.odoo.com/start

### Response
- **host** (string) - The URL of the test database.
- **database** (string) - The name of the test database.
- **user** (string) - The username for authentication.
- **password** (string) - The password for authentication.
```

--------------------------------

### Create and Use a New Registry

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/frontend/registries.html

Demonstrates how to create a new registry instance, add a key-value pair, and retrieve the value. This is useful for custom extensions.

```javascript
import { Registry } from "@web/core/registry";

const myRegistry = new Registry();

myRegistry.add("hello", "odoo");

console.log(myRegistry.get("hello"));

```

--------------------------------

### Install Enterprise .deb Package on Linux

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/community_to_enterprise.html

Install the Odoo Enterprise .deb package over the existing Community installation on Linux.

```bash
$ sudo dpkg -i <path_to_enterprise_deb>

```

--------------------------------

### Add Odoo Repository and Install on Debian/Ubuntu

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/packages.html

Adds the Odoo nightly repository and installs the Odoo Community edition. Updates the package list before installation.

```bash
$ wget -q -O - https://nightly.odoo.com/odoo.key | sudo gpg --dearmor -o /usr/share/keyrings/odoo-archive-keyring.gpg
$ echo 'deb [signed-by=/usr/share/keyrings/odoo-archive-keyring.gpg] https://nightly.odoo.com/19.0/nightly/deb/ ./' | sudo tee /etc/apt/sources.list.d/odoo.list
$ sudo apt-get update && sudo apt-get install odoo

```

--------------------------------

### Importing core utilities

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/frontend/framework_overview.html

Use the @web prefix to import modules from the web/static/src directory.

```javascript
import { memoize } from "@web/core/utils/functions";
```

--------------------------------

### Install rtlcss with npm (Windows)

Source: https://www.odoo.com/documentation/saas-19.1/administration/on_premise/source.html

Installs the rtlcss package globally using npm on Windows. Ensure the npm installation path is added to the system PATH.

```bash
C:\> npm install -g rtlcss

```

--------------------------------

### Install a Module

Source: https://www.odoo.com/documentation/saas-19.1/administration/odoo_sh/advanced/containers.html

Install a specific module using the odoo-bin command with the -i flag. The --stop-after-init option ensures the server shuts down after initialization.

```bash
$  odoo-bin -i sale --stop-after-init
```

--------------------------------

### Clone the Odoo Petstore Module

Source: https://www.odoo.com/documentation/saas-19.1/developer/tutorials/web.html

Use this command to download the example module for testing the Odoo web framework.

```bash
$ git clone http://github.com/odoo/petstore
```

--------------------------------

### Install ipdb Debugger

Source: https://www.odoo.com/documentation/saas-19.1/developer/tutorials/setup_guide.html

Install the ipdb library for interactive Python debugging.

```bash
pip install ipdb
```

--------------------------------

### Install Odoo modules

Source: https://www.odoo.com/documentation/saas-19.1/developer/reference/cli.html

Installs the specified modules into an initialized Odoo database.

```bash
$ odoo-bin module install <modules>
```

--------------------------------

### Run Odoo Server with Configuration

Source: https://www.odoo.com/documentation/saas-19.1/developer/howtos/website_themes/setup.html

Launches the Odoo server using the odoo-bin script, specifying addon paths, database filters, modules to initialize, development features, and demo data settings.

```bash
./odoo-bin --addons-path=../enterprise,addons --db-filter=<database> -d <database> -i website --dev=xml --without-demo=True

```
Tokens:
Raw