odoo-forge-bundle 0.1.0

package/payload/skills/odoo18-docs/references/docs/administration/on_premise/source.md

@@ -0,0 +1,487 @@
+---
+title: "Source install"
+source_url: "https://docs.odoo.sbggai.top/administration/on_premise/source.html"
+---
+
+==============
+# Source install
+
+The source 'installation' is not about installing Odoo but running it directly from the source
+instead.
+
+Using the Odoo source can be more convenient for module developers as it is more easily accessible
+than using packaged installers.
+
+It makes starting and stopping Odoo more flexible and explicit than the services set up by the
+packaged installers. Also, it allows overriding settings using :ref:`command-line parameters
+<reference/cmdline>` without needing to edit a configuration file.
+
+Finally, it provides greater control over the system's setup and allows to more easily keep (and
+run) multiple versions of Odoo side-by-side.
+
+## Fetch the sources
+
+There are two ways to obtain the source code of Odoo: as a ZIP **archive** or through **Git**.
+
+### Archive
+
+Community edition:
+
+- [Odoo download page ](https://www.odoo.com/page/download)
+- [GitHub Community repository ](https://github.com/odoo/odoo)
+- [Nightly server ](https://nightly.odoo.com)
+
+Enterprise edition:
+
+- [Odoo download page ](https://www.odoo.com/page/download)
+- [GitHub Enterprise repository ](https://github.com/odoo/enterprise)
+
+.. _install/source/git:
+
+### Git
+
+> **note**:
+>    It is required to have [Git ](https://git-scm.com/) installed, and it is recommended to have a
+   basic knowledge of Git commands to proceed.
+
+To clone a Git repository, choose between cloning with HTTPS or SSH. In most cases, the best option
+is HTTPS. However, choose SSH to contribute to Odoo source code or when following the :doc:`Getting
+Started developer tutorial </developer/tutorials/server_framework_101>`.
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      .. tabs::
+
+         .. tab:: Clone with HTTPS
+
+            ```console
+
+               $ git clone https://github.com/odoo/odoo.git
+               $ git clone https://github.com/odoo/enterprise.git
+
+         .. tab:: Clone with SSH
+
+            ```console
+
+               $ git clone git@github.com:odoo/odoo.git
+               $ git clone git@github.com:odoo/enterprise.git
+
+   .. group-tab:: Windows
+
+      .. tabs::
+
+         .. tab:: Clone with HTTPS
+
+            ```doscon
+
+               C:\> git clone https://github.com/odoo/odoo.git
+               C:\> git clone https://github.com/odoo/enterprise.git
+
+         .. tab:: Clone with SSH
+
+            ```doscon
+
+               C:\> git clone git@github.com:odoo/odoo.git
+               C:\> git clone git@github.com:odoo/enterprise.git
+
+   .. group-tab:: Mac OS
+
+      .. tabs::
+
+         .. tab:: Clone with HTTPS
+
+            ```console
+
+               $ git clone https://github.com/odoo/odoo.git
+               $ git clone https://github.com/odoo/enterprise.git
+
+         .. tab:: Clone with SSH
+
+            ```console
+
+               $ git clone git@github.com:odoo/odoo.git
+               $ git clone git@github.com:odoo/enterprise.git
+
+> **note**:
+>    **The Enterprise git repository does not contain the full Odoo source code**. It is only a
+   collection of extra add-ons. The main server code is in the Community edition. Running the
+   Enterprise version means running the server from the Community version with the `addons-path`
+   option set to the folder with the Enterprise edition. It is required to clone both the Community
+   and Enterprise repositories to have a working Odoo Enterprise installation.
+
+.. _install/source/prepare:
+
+## Prepare
+
+### Python
+
+Odoo requires **Python 3.10** or later to run.
+
+.. versionchanged:: 17
+    Minimum requirement updated from Python 3.7 to Python 3.10.
+
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      Use a package manager to download and install Python 3 if needed.
+
+   .. group-tab:: Windows
+
+      [Download the latest version of Python 3 ](https://www.python.org/downloads/windows/) and
+      install it.
+
+      During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and
+      make sure that **pip** is checked.
+
+   .. group-tab:: Mac OS
+
+      Use a package manager ([Homebrew ](https://brew.sh/), [MacPorts ](https://www.macports.org))
+      to download and install Python 3 if needed.
+
+> **note**:
+>    If Python 3 is already installed, make sure that the version is 3.10 or above, as previous
+   versions are not compatible with Odoo.
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         ```console
+
+            $ python3 --version
+
+      .. group-tab:: Windows
+
+         ```doscon
+
+            C:\> python --version
+
+      .. group-tab:: Mac OS
+
+         ```console
+
+            $ python3 --version
+
+   Verify that [pip ](https://pip.pypa.io) is also installed for this version.
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         ```console
+
+            $ pip3 --version
+
+      .. group-tab:: Windows
+
+         ```doscon
+
+            C:\> pip --version
+
+      .. group-tab:: Mac OS
+
+         ```console
+
+            $ pip3 --version
+
+### PostgreSQL
+
+Odoo uses PostgreSQL as its database management system.
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      Use a package manager to download and install PostgreSQL (supported versions: 12.0 or above).
+      It can be achieved by executing the following:
+
+      ```console
+
+         $ sudo apt install postgresql postgresql-client
+
+   .. group-tab:: Windows
+
+      [Download PostgreSQL ](https://www.postgresql.org/download/windows) (supported versions: 12.0
+      or above) and install it.
+
+   .. group-tab:: Mac OS
+
+      Use [Postgres.app ](https://postgresapp.com) to download and install PostgreSQL (supported
+      version: 12.0 or above).
+
+      > **tip**:
+>          To make the command line tools bundled with Postgres.app available, make sure to set up the
+         `$PATH` variable by following the [Postgres.app CLI tools instructions
+         ](https://postgresapp.com/documentation/cli-tools.html).
+
+By default, the only user is `postgres`. As Odoo forbids connecting as `postgres`, create a new
+PostgreSQL user.
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      ```console
+
+         $ sudo -u postgres createuser -d -R -S $USER
+         $ createdb $USER
+
+      > **note**:
+>          Because the PostgreSQL user has the same name as the Unix login, it is possible to connect
+         to the database without a password.
+
+   .. group-tab:: Windows
+
+      #. Add PostgreSQL's `bin` directory (by default:
+         :file:`C:\\Program Files\\PostgreSQL\\<version>\\bin`) to the `PATH`.
+      #. Create a postgres user with a password using the pg admin gui:
+
+         #. Open **pgAdmin**.
+         #. Double-click the server to create a connection.
+         #. Select :menuselection:`Object --> Create --> Login/Group Role`.
+         #. Enter the username in the **Role Name** field (e.g., `odoo`).
+         #. Open the **Definition** tab, enter a password (e.g., `odoo`), and click **Save**.
+         #. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?**
+            to `Yes`.
+
+   .. group-tab:: Mac OS
+
+      ```console
+
+         $ sudo -u postgres createuser -d -R -S $USER
+         $ createdb $USER
+
+      > **note**:
+>          Because the PostgreSQL user has the same name as the Unix login, it is possible to connect
+         to the database without a password.
+
+.. _install/dependencies:
+
+### Dependencies
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      Using **distribution packages** is the preferred way of installing dependencies.
+      Alternatively, install the Python dependencies with **pip**.
+
+      .. tabs::
+
+         .. tab:: Debian/Ubuntu
+
+            On Debian/Ubuntu, the following commands should install the required packages:
+
+            ```console
+
+               $ cd odoo #CommunityPath
+               $ sudo ./setup/debinstall.sh
+
+            The `setup/debinstall.sh` script will parse the [debian/control
+            ]({GITHUB_PATH}/debian/control) file and install the found packages.
+
+         .. tab:: Install with pip
+
+            > **warning**:
+>                Using pip may lead to security issues and broken dependencies; only do this if you
+               know what you are doing.
+
+            As some of the Python packages need a compilation step, they require system libraries to
+            be installed.
+
+            On Debian/Ubuntu, the following command should install these required libraries:
+
+            ```console
+
+               $ sudo apt install python3-pip libldap2-dev libpq-dev libsasl2-dev
+
+            Odoo dependencies are listed in the :file:`requirements.txt` file located at the root of
+            the Odoo Community directory.
+
+            > **note**:
+>                The Python packages in :file:`requirements.txt` are based on their stable/LTS
+               Debian/Ubuntu corresponding version at the moment of the Odoo release. For example,
+               for Odoo 15.0, the `python3-babel` package version is 2.8.0 in Debian Bullseye and
+               2.6.0 in Ubuntu Focal. The lowest version is then chosen in the
+               :file:`requirements.txt`.
+
+            > **tip**:
+>                It can be preferable not to mix Python module packages between different instances of
+               Odoo or with the system. However, it is possible to use [virtualenv
+               ](https://pypi.org/project/virtualenv/) to create isolated Python environments.
+
+            Navigate to the path of the Odoo Community installation (:file:`CommunityPath`) and run
+            **pip** on the requirements file to install the requirements for the current user.
+
+            ```console
+
+               $ cd /CommunityPath
+               $ pip install -r requirements.txt
+
+   .. group-tab:: Windows
+
+      Before installing the dependencies, download and install the [Build Tools for Visual
+      Studio ](https://visualstudio.microsoft.com/downloads/). Select **C++ build tools** in the
+      **Workloads** tab and install them when prompted.
+
+      Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
+      Community directory.
+
+         > **tip**:
+>             It can be preferable not to mix Python module packages between different instances of
+            Odoo or with the system. However, it is possible to use [virtualenv
+            ](https://pypi.org/project/virtualenv/) to create isolated Python environments.
+
+      Navigate to the path of the Odoo Community installation (`CommunityPath`) and run **pip** on
+      the requirements file in a terminal **with Administrator privileges**:
+
+      ```doscon
+
+         C:\> cd \CommunityPath
+         C:\> pip install setuptools wheel
+         C:\> pip install -r requirements.txt
+
+   .. group-tab:: Mac OS
+
+      Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
+      Community directory.
+
+         > **tip**:
+>             It can be preferable not to mix Python module packages between different instances of
+            Odoo or with the system. However, it is possible to use [virtualenv
+            ](https://pypi.org/project/virtualenv/) to create isolated Python environments.
+
+      Navigate to the path of the Odoo Community installation (`CommunityPath`) and run **pip** on
+      the requirements file:
+
+      ```console
+
+         $ cd /CommunityPath
+         $ pip3 install setuptools wheel
+         $ pip3 install -r requirements.txt
+
+      > **warning**:
+>          Non-Python dependencies must be installed with a package manager ([Homebrew
+         ](https://brew.sh/), [MacPorts ](https://www.macports.org)).
+
+         #. Download and install the **Command Line Tools**:
+
+            ```console
+
+               $ xcode-select --install
+
+         #. Use the package manager to install non-Python dependencies.
+
+> **note**:
+>    For languages using a **right-to-left interface** (such as Arabic or Hebrew), the `rtlcss`
+   package is required.
+
+   .. tabs::
+
+      .. group-tab:: Linux
+
+         #. Download and install **nodejs** and **npm** with a package manager.
+         #. Install `rtlcss`:
+
+            ```console
+
+               $ sudo npm install -g rtlcss
+
+      .. group-tab:: Windows
+
+         #. Download and install [nodejs ](https://nodejs.org/en/download).
+         #. Install `rtlcss`:
+
+            ```doscon
+
+               C:\> npm install -g rtlcss
+
+         #. Edit the system environment's variable `PATH` to add the folder where `rtlcss.cmd` is
+            located (typically: :file:`C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
+
+      .. group-tab:: Mac OS
+
+         #. Download and install **nodejs** with a package manager ([Homebrew ](https://brew.sh/),
+            [MacPorts ](https://www.macports.org)).
+         #. Install `rtlcss`:
+
+            ```console
+
+               $ sudo npm install -g rtlcss
+
+> **warning**:
+>    `wkhtmltopdf` is not installed through **pip** and must be installed manually in [version 0.12.6
+   ](https://github.com/wkhtmltopdf/packaging/releases/tag/0.12.6.1-3) for it to support headers
+   and footers. Check out the [wkhtmltopdf wiki ](https://github.com/odoo/odoo/wiki/Wkhtmltopdf)
+   for more details on the various versions.
+
+.. _install/source/running_odoo:
+
+## Running Odoo
+
+Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the command-line
+interface of the server. It is located at the root of the Odoo Community directory.
+
+To configure the server, either specify :ref:`command-line arguments <reference/cmdline/server>` or
+a :ref:`configuration file <reference/cmdline/config>`.
+
+> **tip**:
+>    For the Enterprise edition, add the path to the `enterprise` add-ons to the `addons-path`
+   argument. Note that it must come before the other paths in `addons-path` for add-ons to be loaded
+   correctly.
+
+Common necessary configurations are:
+
+- PostgreSQL user and password.
+- Custom addon paths beyond the defaults to load custom modules.
+
+A typical way to run the server would be:
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      ```console
+
+         $ cd /CommunityPath
+         $ python3 odoo-bin --addons-path=addons -d mydb
+
+      Where `CommunityPath` is the path of the Odoo Community installation, and `mydb` is the name
+      of the PostgreSQL database.
+
+   .. group-tab:: Windows
+
+      ```doscon
+
+         C:\> cd CommunityPath/
+         C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
+
+      Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
+      PostgreSQL login, `dbpassword` is the PostgreSQL password, and `mydb` is the name of the
+      PostgreSQL database.
+
+   .. group-tab:: Mac OS
+
+      ```console
+
+         $ cd /CommunityPath
+         $ python3 odoo-bin --addons-path=addons -d mydb
+
+      Where `CommunityPath` is the path of the Odoo Community installation, and `mydb` is the name
+      of the PostgreSQL database.
+
+After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
+http://localhost:8069 in a web browser and log into the Odoo database with the base administrator
+account: use `admin` as the email and, again, `admin` as the password.
+
+> **tip**:
+>    - From there, create and manage new :doc:`users <../../applications/general/users>`.
+   - The user account used to log into Odoo's web interface differs from the :option:`--db_user
+     <odoo-bin -r>` CLI argument.
+
+.. seealso::
+   :doc:`The list of CLI arguments for odoo-bin </developer/reference/cli>`

package/payload/skills/odoo18-docs/references/docs/administration/on_premise/update.md

@@ -0,0 +1,146 @@
+---
+title: ""
+source_url: "https://docs.odoo.sbggai.top/administration/on_premise/update.html"
+---
+
+
+.. _setup/update:
+# 
+# Bugfix updates
+
+# Introduction
+
+In order to benefit from the latest improvements, security fixes, bug corrections and
+performance boosts, you may need to update your Odoo installation from time to time.
+
+This guide only applies when are using Odoo on your own hosting infrastructure.
+If you are using one of the Odoo Cloud solutions, updates are automatically performed for you.
+
+The terminology surrounding software updates is often confusing, so here are some preliminary
+definitions:
+
+Updating (an Odoo installation)
+  Refers to the process of obtaining the latest revision of the source code for
+  your current Odoo Edition. For example, updating your Odoo Enterprise 13.0 to the
+  latest revision.
+  This does not directly cause any change to the contents of your Odoo database, and
+  can be undone by reinstalling the previous revision of the source code.
+
+Upgrading (an Odoo database)
+  Refers to a complex data processing operation where the structure and contents of your
+  database is permanently altered to make it compatible with a new release of Odoo.
+  This operation is irreversible and typically accomplished via Odoo's
+  [database upgrade service ](https://upgrade.odoo.com), when you decide to
+  switch to a newer release of Odoo.
+  Historically, this process has also been known as a "migration" because it involves moving data
+  around inside the database, even though the database may end up at the same physical location
+  after the upgrade.
+
+This page describes the typical steps needed to *update* an Odoo installation to the latest
+version. If you'd like more information about upgrading a database, please visit the
+[Odoo Upgrade page ](https://upgrade.odoo.com) instead.
+
+
+# In a nutshell
+
+Updating Odoo is accomplished by simply reinstalling the latest version of your Odoo
+Edition on top of your current installation. This will preserve your data without any alteration,
+as long as you do not uninstall PostgreSQL (the database engine that comes with Odoo).
+
+The main reference for updating is logically our :doc:`installation guide <../on_premise>`,
+which explains the common installation methods.
+
+Updating is also most appropriately accomplished by the person who deployed Odoo initially,
+because the procedure is very similar.
+
+.. note:: We always recommend to download a complete new up-to-date Odoo version, rather than
+          manually applying patches, such as the security patches that come with Security
+          Advisories.
+          The patches are mainly provided for installations that are heavily customized, or for
+          technical personnel who prefer to apply minimal changes temporarily while testing a
+          complete update.
+
+
+# Step 1: Download an updated Odoo version
+
+The central download page is https://www.odoo.com/page/download. If you see a "Buy" link for the
+Odoo Enterprise download, make sure you are logged into Odoo.com with the same login that is
+linked to your Odoo Enterprise subscription.
+
+Alternatively, you can use the unique download link that was included with your Odoo Enterprise
+purchase confirmation email.
+
+.. note:: Downloading an updated version is not necessary if you installed via Github (see below)
+
+
+# Step 2: Make a backup of your database
+
+The update procedure is quite safe and should not alter you data. However it's always best to take
+a full database backup before performing any change on your installation, and to store it somewhere
+safe, on a different computer.
+
+If you have not disabled the database manager screen (see :ref:`here <security>` why you should), you
+can use it (link at bottom of your database selection screen) to download a backup of your
+database(s). If you disabled it, use the same procedure than for your usual backups.
+
+
+# Step 3: Install the updated version
+
+Choose the method that matches your current installation:
+
+
+## Packaged Installers
+
+If you installed Odoo with an installation package downloaded on our website (the recommended method),
+updating is very simple.
+All you have to do is download the installation package corresponding to your system (see step #1)
+and install it on your server. They are updated daily and include the latest security fixes.
+Usually, you can simply double-click the package to install it on top of the current installation.
+After installing the package, be sure to restart the Odoo service or reboot your server,
+and you're all set.
+
+## Source Install (Tarball)
+
+If you have originally installed Odoo with the "tarball" version (source code archive), you have
+to replace the installation directory with a newer version. First download the latest tarball
+from Odoo.com. They are updated daily and include the latest security fixes (see step #1)
+After downloading the package, extract it to a temporary location on your server.
+
+You will get a folder labeled with the version of the source code, for example "odoo-13.0+e.20190719",
+that contains a folder "odoo.egg-info" and the actual source code folder named "odoo" (for Odoo 10
+and later) or "openerp" for older versions.
+You can ignore the odoo.egg-info folder. Locate the folder where your current installation is deployed,
+and replace it with the newer "odoo" or "openerp" folder that was in the archive you just extracted.
+
+Be sure to match the folder layout, for example the new "addons" folder included in the source code
+should end up exactly at the same path it was before. Next, watch out for any specific configuration
+files that you may have manually copied or modified in the old folder, and copy them over to the
+new folder.
+Finally, restart the Odoo service or reboot the machine, and you are all set.
+
+## Source Install (Github)
+
+If you have originally installed Odoo with a full Github clone of the official repositories, the
+update procedure requires you to pull the latest source code via git.
+Change into the directory for each repository (the main Odoo repository, and the Enterprise
+repository), and run the following commands::
+
+     git fetch
+     git rebase --autostash
+
+The last command may encounter source code conflicts if you had edited the Odoo source code locally.
+The error message will give you the list of files with conflicts, and you will need to resolve
+the conflicts manually, by editing them and deciding which part of the code to keep.
+
+Alternatively, if you prefer to simply discard the conflicting changes and restore the official
+version, you can use the following command::
+
+     git reset --hard
+
+Finally, restart the Odoo service or reboot the machine, and you should be done.
+
+
+## Docker
+
+Please refer to our [Docker image documentation ](https://hub.docker.com/_/odoo/) for
+specific update instructions.