From 83e9c0ab6a667fb6302e33d724a295f42ad8b11d Mon Sep 17 00:00:00 2001
From: Fabian Rodriguez <317514+MagicFab@users.noreply.github.com>
Date: Tue, 5 Nov 2024 14:33:32 -0500
Subject: [PATCH] Update README.md with Debian and Ubuntu install instructions
Add instructions for Debian 12 and test/combine such instructions for Ubuntu 24.04 LTS too.
---
README.md | 44 +++++++++++++++++++++++++++-----------------
1 file changed, 27 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 7223af7..8a17f87 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,39 @@
# ERPLibre
ERPLibre is a CRM/ERP platform including automated installation, maintenance, and development of open source modules of
-the Odoo community version. It is a "soft-fork" of the Odoo Community version, meaning it aims at contributing back
-upstream. It is based on a set of production-ready modules, supported by the Odoo Community Association (OCA) and an
+the Odoo community version. It is a "soft-fork" of the Odoo Community Edition (OCE), meaning it aims at contributing back
+upstream.
+It is based on a set of production-ready modules, supported by the Odoo Community Association (OCA) and an
ecosystem of specialized companies. This solution ensures digital sovereignty in a local environment while integrating
pre-trained Generative Transformers (GPT), bringing an additional dimension to data management and automation.
-# ERPLibre documentation
+# Installation
Select a guide to install your environment.
-## Easy way to run locally
+## Easy install on Ubuntu or Debian using Docker
+
+This has been tested in Debian 12 and Ubuntu 24.04 LTS.
+
+**Note** : This is meant for a test environment, on a local network or similar environment not directly exposed to the Internet.
+
+1. Make sure Docker and nginx web server are installed:
+```sudo apt install docker docker-compose nginx```
+1. Get the latest ERPLibre Docker compose file:
+```wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/v1.5.0/docker-compose.yml```
+1. Install and run ERPLibre with Docker running as a daemon (web server):
+```sudo docker-compose up -d```
+1. Open the final installation step at this web page :
+```http://[server IP]:8069```
+
+1. Finish the installation by providing a database name, email and password. then click on **Create Database**. Depending on your system resources **this may take more than 2 minutes without feedback !** Check your browser loading indicator.
+1. Next, the web page will reload itself and you should see the Applications list in ERPLibre:
+
+You can now personalize your ERPLibre installation.
+
+For more information, read [Docker guide](./docker/README.md).
+
+## Install from source code
Into Ubuntu, minimal dependency:
@@ -55,19 +78,6 @@ Ready to execute:
make run
```
-## Easy way to run docker
-
-First, install dependencies to run docker, check script `./script/install/install_ubuntu_docker.sh`. You need docker and
-docker-compose.
-
-The docker volume is bound to the directory name, therefore create a unique directory name and run:
-
-```bash
-wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/v1.5.0/docker-compose.yml
-docker compose up -d
-```
-
-For more information, read [Docker guide](./docker/README.md).
## Discover guide