From 30da710d0124248bd3dd01e0e98415cfa102207f Mon Sep 17 00:00:00 2001 From: Richard Sassine Date: Mon, 3 May 2021 18:28:16 +0300 Subject: Added module installation docs and restructured. --- src/.configuration/running.md | 1 + src/.configuration/running_odoo.md | 1 + src/SUMMARY.md | 14 ++++- src/backups.md | 13 ----- src/configuration/index.md | 4 ++ src/configuration/running_odoo.md | 66 ++++++++++++++++++++++ src/installation.md | 11 ---- src/installation/common_tasks.md | 47 +++++++++++++++ src/installation/index.md | 3 + src/installation/installing_odoo.md | 12 ++++ .../third_party_modules/automated_backups.md | 34 +++++++++++ .../third_party_modules/backend_web_theme.md | 25 ++++++++ .../third_party_modules/extend_partners.md | 19 +++++++ .../third_party_modules/frontend_web_theme.md | 25 ++++++++ src/installation/third_party_modules/helpdesk.md | 34 +++++++++++ src/installation/third_party_modules/index.md | 4 ++ src/running.md | 66 ---------------------- 17 files changed, 286 insertions(+), 93 deletions(-) create mode 100644 src/.configuration/running.md create mode 100644 src/.configuration/running_odoo.md delete mode 100644 src/backups.md create mode 100644 src/configuration/index.md create mode 100644 src/configuration/running_odoo.md delete mode 100644 src/installation.md create mode 100644 src/installation/common_tasks.md create mode 100644 src/installation/index.md create mode 100644 src/installation/installing_odoo.md create mode 100644 src/installation/third_party_modules/automated_backups.md create mode 100644 src/installation/third_party_modules/backend_web_theme.md create mode 100644 src/installation/third_party_modules/extend_partners.md create mode 100644 src/installation/third_party_modules/frontend_web_theme.md create mode 100644 src/installation/third_party_modules/helpdesk.md create mode 100644 src/installation/third_party_modules/index.md delete mode 100644 src/running.md diff --git a/src/.configuration/running.md b/src/.configuration/running.md new file mode 100644 index 0000000..1b2231d --- /dev/null +++ b/src/.configuration/running.md @@ -0,0 +1 @@ +# Running Odoo diff --git a/src/.configuration/running_odoo.md b/src/.configuration/running_odoo.md new file mode 100644 index 0000000..1b2231d --- /dev/null +++ b/src/.configuration/running_odoo.md @@ -0,0 +1 @@ +# Running Odoo diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 9b2ee76..1c2a663 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,6 +2,14 @@ # Deploying Odoo -- [Installing Odoo](./installation.md) -- [Running Odoo](./running.md) -- [Automated Backups](./backups.md) +- [Installation](./installation/index.md) + - [Installing Odoo](./installation/installing_odoo.md) + - [Common Tasks](./installation/common_tasks.md) + - [Third-Party Modules](./installation/third_party_modules/index.md) + - [Automated Backups](./installation/third_party_modules/automated_backups.md) + - [Backend Web Theme](./installation/third_party_modules/backend_web_theme.md) + - [Frontend Web Theme](./installation/third_party_modules/frontend_web_theme.md) + - [Helpdesk](./installation/third_party_modules/helpdesk.md) + - [Extend Partners](./installation/third_party_modules/extend_partners.md) +- [Configuration](./configuration/index.md) + - [Running Odoo](.configuration/running_odoo.md) diff --git a/src/backups.md b/src/backups.md deleted file mode 100644 index 15b1093..0000000 --- a/src/backups.md +++ /dev/null @@ -1,13 +0,0 @@ -# Configuring Automated Backups - -In older versions of Odoo a simple POST request delivered by a `curl` command -within regular intervals via `cronie` would be enough for this. However, Odoo -v14.0 seems to have changed some aspect of the process and broken it. - -As an alternative we will be using -[this](https://github.com/Yenthe666/auto_backup) -module. - -Simply clone the repo into your addons path and install it.The settings are -accessable at `Settings > Technical > Back-Ups` and -`Settings > Technical > Automation` when in __debug mode__. diff --git a/src/configuration/index.md b/src/configuration/index.md new file mode 100644 index 0000000..104d3ae --- /dev/null +++ b/src/configuration/index.md @@ -0,0 +1,4 @@ +# Configuration + +This section describes backend and frontend configurations for features which +are not already documented in Odoo's documentation. diff --git a/src/configuration/running_odoo.md b/src/configuration/running_odoo.md new file mode 100644 index 0000000..cd5868a --- /dev/null +++ b/src/configuration/running_odoo.md @@ -0,0 +1,66 @@ +# Running The Server + +Once the source install is properly set up the Odoo instance can be started by +running the `odoo-bin` script in the install directory. This will run the odoo +instance and bind it to port 8069 which is the default. + +For more info pass the `--help` flag to the script. Here are some useful flags: +- `-d` tells the script you want a specific databse to be selected. Also hides + other databases from the selector. +- `-p` sets the port the instance will bind to +- `--addons-path` used to specify additional addon paths (like your development + environment) +- `-s` saves certain options in the `~/.odoorc` file so you don't have to pass + them to the launcher script every time. Use this once to easily configure + your instance instead of editing the `~/.odoorc` file manually. + +# Configuring Services + +Odoo's community code repository includes a service file fittign for +SystemD-based distributions. Here are the steps to enable it: + +1. Make a simple bash script to run the `odoo-bin` script with + instance-specific arguments like so: + ``` + #!/bin/bash + ./odoo-bin -p [port] -c [path/to/configuration/file/for/this/instance] -d [databases name] --no-database-list + ``` + Then give it excecution permissions: + ``` + chmod +x [path/to/your/script] + ``` + +2. Make a SystemD service in `/usr/lib/systemd/system/` to launch and monitor + your launching script at boot: + ``` + [Unit] + Description=Odoo + After=postgresql.service + + [Service] + Type=simple + User=[your username] + Group=[your username] + WorkingDirectory=[path/to/scripts/working/directory] + ExecStart=[path/to/your/launch/script] + + [Install] + WantedBy=multi-user.target + ``` + +3. Enable the service so that it runs on boot. + ``` + sudo systemctl enable odoo.service + ``` + +4. Start the service. + ``` + sudo systemctl start odoo.service + ``` + +## Running Multiple Instances + +To run additional services simply make seperate scripts and service files for +each while changing arguments accordingly (especially the port number). + + diff --git a/src/installation.md b/src/installation.md deleted file mode 100644 index 69dd300..0000000 --- a/src/installation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Installing Odoo -There are multiple ways to install Odoo but for development purposes a source -install is best for debugging and accessibility. - -For the most part following the -[Odoo documentation](https://www.odoo.com/documentation/14.0/setup/install.html#id7}) -will be enough as the packages they tell us to install will be present on most -mainstream GNU+Linux distributions such as Debian, Ubuntu, Fedora etc. - -On more obscure distributions like Void, Parabola and Gentoo users would -have to look for these packages themselves as naming can differ. diff --git a/src/installation/common_tasks.md b/src/installation/common_tasks.md new file mode 100644 index 0000000..1dbb95c --- /dev/null +++ b/src/installation/common_tasks.md @@ -0,0 +1,47 @@ +# About + +This page describes unintuitive tasks that are commonly done in the process of +installing Odoo and its addons. + + +# Debug Mode + +You can enable debug mode through the web GUI at the bottom of the Settings +app's page or by changing the portion of the url that reads `web#` to +`web?debug=1#`. For example: +``` +https://wifast.net/web#action=153&cids=1&menu_id=114 +``` +becomes +``` +https://wifast.net/web?debug=1#action=153&cids=1&menu_id=114 +``` +You'll know you're in debug mode when you see a bug icon in the right side of +the page header. + + +# Installing Modules + +After having placed the module's files in the proper directory you can install +it in one of two ways: + +- Frontend install: + 1- Get into debug mode. + 2- Go to the Apps app. + 3- Click the "Update Apps List" in the page header. + 4- Search for your new module and install it. +- Backend install: + 1- Restart the Odoo instance with the -u flag with your app's name as an + argument (eg.: `-u crm` to install the CRM module) + +Note: The backend option is preferable for developers as it's quicker and more +verbose. + + +# Importing Records +In prior versions of Odoo the Import button was next to the Create button on +all views. In version 14.0 the Odoo team moved it into the Favorites submenu +because new users would often hit it by mistake and get confused (!!!). + +Until they fix this idiotic design choice you can still find the feature at +`Favorites > Import Records` diff --git a/src/installation/index.md b/src/installation/index.md new file mode 100644 index 0000000..d0e2c89 --- /dev/null +++ b/src/installation/index.md @@ -0,0 +1,3 @@ +# Installation + +This section includes general information about the process of installing Void. diff --git a/src/installation/installing_odoo.md b/src/installation/installing_odoo.md new file mode 100644 index 0000000..4e232d6 --- /dev/null +++ b/src/installation/installing_odoo.md @@ -0,0 +1,12 @@ +# Installing Odoo + +There are multiple ways to install Odoo but for development purposes a source +install is best for debugging and accessibility. + +For the most part following the +[Odoo documentation](https://www.odoo.com/documentation/14.0/setup/install.html#id7}) +will be enough as the packages they tell us to install will be present on most +mainstream GNU+Linux distributions such as Debian, Ubuntu, Fedora etc. + +On more obscure distributions like Void, Parabola and Gentoo users would +have to look for these packages themselves as naming can differ. diff --git a/src/installation/third_party_modules/automated_backups.md b/src/installation/third_party_modules/automated_backups.md new file mode 100644 index 0000000..b408ba0 --- /dev/null +++ b/src/installation/third_party_modules/automated_backups.md @@ -0,0 +1,34 @@ +# Description + +Due to changes in the way Odoo 14.0 handles POST request, the old `curl` +method no longer works. This module fills that gap while providing some +front-end configuration options. + + +# Installation + +First we clone the git repository into a directory that's included in our +addons-path. +``` +git clone https://github.com/Yenthe666/auto_backup +``` +Then we switch to the "14.0" branch (At the time of writing this is not the +default). +``` +git checkout 14.0 +``` +Finally we can install the module via the frontend or backend as specified in +the "[Common Tasks](../common_tasks.md)" section. + + +# Configuration + +The settings for this module are accessable at +`Settings > Technical > Back-Ups` and +`Settings > Technical > Automation` when in __debug mode__. + +The "Back-Ups" menu creates backup jobs which are all run on a set interval +which is configured in the afore mentioned "Automation" menu. + +# Links +[Github Repository](https://github.com/Yenthe666/auto_backup) diff --git a/src/installation/third_party_modules/backend_web_theme.md b/src/installation/third_party_modules/backend_web_theme.md new file mode 100644 index 0000000..25f3b7a --- /dev/null +++ b/src/installation/third_party_modules/backend_web_theme.md @@ -0,0 +1,25 @@ +# Description + +We use a backend web theme to configure the look and flow of Odoo's web UI. + + +# Installation + +Grab a copy of the module's files from its +[odoo app listing](https://apps.odoo.com/apps/themes/14.0/muk_web_theme/) and +place them in the proper directory. +Then install the module via the frontend or backend as specified in +the "[Common Tasks](../common_tasks.md)" section. + +Be sure to also copy over any "web\_responsive" directories the app came with. + + +# Configuration + +The settings for this module are accessable at +`Settings > General Settings` + + +# Links + +[Odoo App Listing](https://apps.odoo.com/apps/themes/14.0/muk_web_theme/) diff --git a/src/installation/third_party_modules/extend_partners.md b/src/installation/third_party_modules/extend_partners.md new file mode 100644 index 0000000..88a03a4 --- /dev/null +++ b/src/installation/third_party_modules/extend_partners.md @@ -0,0 +1,19 @@ +# Description + +This module extends the "partner" (contact) model with extra fields and +view customizations. + +# Installation + +Clone the relevant git repository from our git server (if you're a developer +you should have the credentials for it). +Then install the module via the frontend or backend as specified in +the "[Common Tasks](../common_tasks.md)" section. + + +# Configuration + +This module has no settings. + +# Links +[Our Git Repositories](https://git.wifast.net) diff --git a/src/installation/third_party_modules/frontend_web_theme.md b/src/installation/third_party_modules/frontend_web_theme.md new file mode 100644 index 0000000..069407e --- /dev/null +++ b/src/installation/third_party_modules/frontend_web_theme.md @@ -0,0 +1,25 @@ +# Description + +This frontend web theme forms the foundation of our website design. It +primarily changes the look and feel of UI elements such as buttons, menus, divs +etc. + + +# Installation + +Grab a copy of the module's files from its +[odoo app listing](https://apps.odoo.com/apps/themes/14.0/theme_zap/) and +place them in the proper directory. +Then install the module via the frontend or backend as specified in +the "[Common Tasks](../common_tasks.md)" section. + +Be sure to also copy over any "theme\_common" directories the app came with. + + +# Configuration + +The settings for this module are accessable in the Website app. + + +# Links +[Odoo App Listing](https://apps.odoo.com/apps/themes/14.0/theme_zap/) diff --git a/src/installation/third_party_modules/helpdesk.md b/src/installation/third_party_modules/helpdesk.md new file mode 100644 index 0000000..4a36e47 --- /dev/null +++ b/src/installation/third_party_modules/helpdesk.md @@ -0,0 +1,34 @@ +# Description + +Since the community version of Odoo does not include the Helpdesk app we will +be using this community-made version instead. + + +# Installation + +First we clone the git repository into a directory that's included in our +addons-path. +``` +git clone https://github.com/OCA/helpdesk +``` +Then we switch to the "14.0" branch (At the time of writing this is not the +default). +``` +git checkout 14.0 +``` +Move the modules you want to the appropriate directory (helpdesk\_mgmt is the +base one) + +Finally we can install the module via the frontend or backend as specified in +the "[Common Tasks](../common_tasks.md)" section. + + +# Configuration + +The settings for this module are accessable in the Helpdesk app. Be sure to +give your users the proper permissions and team assignments. + + +# Links + +[Github Repository](https://github.com/OCA/helpdesk) diff --git a/src/installation/third_party_modules/index.md b/src/installation/third_party_modules/index.md new file mode 100644 index 0000000..e01e246 --- /dev/null +++ b/src/installation/third_party_modules/index.md @@ -0,0 +1,4 @@ +# Third Party Modules + +This section includes general information about the third-party modules that we +use and how to install them. diff --git a/src/running.md b/src/running.md deleted file mode 100644 index cd5868a..0000000 --- a/src/running.md +++ /dev/null @@ -1,66 +0,0 @@ -# Running The Server - -Once the source install is properly set up the Odoo instance can be started by -running the `odoo-bin` script in the install directory. This will run the odoo -instance and bind it to port 8069 which is the default. - -For more info pass the `--help` flag to the script. Here are some useful flags: -- `-d` tells the script you want a specific databse to be selected. Also hides - other databases from the selector. -- `-p` sets the port the instance will bind to -- `--addons-path` used to specify additional addon paths (like your development - environment) -- `-s` saves certain options in the `~/.odoorc` file so you don't have to pass - them to the launcher script every time. Use this once to easily configure - your instance instead of editing the `~/.odoorc` file manually. - -# Configuring Services - -Odoo's community code repository includes a service file fittign for -SystemD-based distributions. Here are the steps to enable it: - -1. Make a simple bash script to run the `odoo-bin` script with - instance-specific arguments like so: - ``` - #!/bin/bash - ./odoo-bin -p [port] -c [path/to/configuration/file/for/this/instance] -d [databases name] --no-database-list - ``` - Then give it excecution permissions: - ``` - chmod +x [path/to/your/script] - ``` - -2. Make a SystemD service in `/usr/lib/systemd/system/` to launch and monitor - your launching script at boot: - ``` - [Unit] - Description=Odoo - After=postgresql.service - - [Service] - Type=simple - User=[your username] - Group=[your username] - WorkingDirectory=[path/to/scripts/working/directory] - ExecStart=[path/to/your/launch/script] - - [Install] - WantedBy=multi-user.target - ``` - -3. Enable the service so that it runs on boot. - ``` - sudo systemctl enable odoo.service - ``` - -4. Start the service. - ``` - sudo systemctl start odoo.service - ``` - -## Running Multiple Instances - -To run additional services simply make seperate scripts and service files for -each while changing arguments accordingly (especially the port number). - - -- cgit v1.2.3