summaryrefslogtreecommitdiff
path: root/src/configuration
diff options
context:
space:
mode:
authorRichard Sassine <richardsassine@tutanota.com>2021-05-03 18:28:16 +0300
committerRichard Sassine <richardsassine@tutanota.com>2021-05-03 18:28:16 +0300
commit30da710d0124248bd3dd01e0e98415cfa102207f (patch)
tree94e4c24828ab0cacd96275a2b682d37697947c88 /src/configuration
parent7c95ca65481667eca029a140c2384b7a7791198d (diff)
Added module installation docs and restructured.
Diffstat (limited to 'src/configuration')
-rw-r--r--src/configuration/index.md4
-rw-r--r--src/configuration/running_odoo.md66
2 files changed, 70 insertions, 0 deletions
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).
+
+