From 5a6d390e37822e8be578f899fdd847d6f69922a7 Mon Sep 17 00:00:00 2001
From: abetoluwani <101352514+abetoluwani@users.noreply.github.com>
Date: Mon, 2 Dec 2024 14:03:11 +0300
Subject: [PATCH] updated linux/ubuntu users installation of docker and docker
compose
---
documentation/docs/installation-ubuntu.md | 119 +++++++++++++++-------
1 file changed, 81 insertions(+), 38 deletions(-)
diff --git a/documentation/docs/installation-ubuntu.md b/documentation/docs/installation-ubuntu.md
index d92b564..411f20e 100644
--- a/documentation/docs/installation-ubuntu.md
+++ b/documentation/docs/installation-ubuntu.md
@@ -42,65 +42,108 @@ nvm install node
-### 2. **Install Docker**
+Here’s the guide formatted in Markdown for better readability:
-- **Add Docker's official GPG key and repository:**
+---
-```
-sudo apt-get update sudo apt-get install -y ca-certificates curl sudo install -m 0755 -d /etc/apt/keyrings sudo curl -fsSL [https://download.docker.com/linux/ubuntu/gpg](https://download.docker.com/linux/ubuntu/gpg) -o /etc/apt/keyrings/docker.asc sudo chmod a+r /etc/apt/keyrings/docker.asc
-```
+## **2. Install Docker**
-
+### **Using Repository and GPG Key**
-- **Add the Docker repository to Apt sources:**
+1. **Add Docker’s official GPG key and repository:**
-```
-echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] [https://download.docker.com/linux/ubuntu](https://download.docker.com/linux/ubuntu) \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-```
+ ```bash
+ sudo apt-get update
+ sudo apt-get install -y ca-certificates curl
+ sudo install -m 0755 -d /etc/apt/keyrings
+ sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+ sudo chmod a+r /etc/apt/keyrings/docker.asc
+ ```
-
+2. **Add Docker repository to Apt sources:**
-- **Update your package list:**
+ ```bash
+ echo \
+ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+ ```
-```
-sudo apt-get update
-```
+3. **Update your package list:**
-
+ ```bash
+ sudo apt-get update
+ ```
-- **Install Docker packages:**
+4. **Install Docker packages:**
-```
-sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-```
+ ```bash
+ sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+ ```
-
+---
-### 3. **Install Docker Compose**
+### **Using Snap**
-
+1. **Install Docker using Snap:**
-- **Download and install Docker Compose:**
+ ```bash
+ sudo snap install docker
+ ```
-```
-sudo curl -L "[https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname](https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname) -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-```
+ This installs the Snap version of Docker, typically updated to version `27.2.0` or later.
-
+## **Verify Installations**
-- **Set the correct permissions:**
+**Check Docker version:**
-```
-sudo chmod +x /usr/local/bin/docker-compose
-```
+ ```bash
+ docker --version
+ ```
-- **Verify the installation:**
+## **3. Install Docker Compose**
+### **Using Repository**
+
+1. **Download and install Docker Compose:**
+
+ ```bash
+ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+ ```
+
+2. **Set correct permissions:**
+
+ ```bash
+ sudo chmod +x /usr/local/bin/docker-compose
+ ```
+
+3. **Verify the installation:**
+
+ ```bash
+ docker-compose --version
+ ```
+
+---
+
+### **Using Snap**
+
+To install Docker Compose directly using Apt, you can use the following command:
+
+```bash
+sudo apt install docker-compose
```
-docker-compose --version
-```
+
+---
+
+## **Verify Installations**
+
+**Check Docker Compose version:**
+
+ ```bash
+ docker-compose --version
+ ```
@@ -141,19 +184,19 @@ After installing the XEST CLI globally, you can now bootstrap your API.
In order to create your API, you need to run the following commmand:
```bash
-$ xx [project-name]
+xx [project-name]
```
With one simple command, you will be installing all the necessary packages, utils, middlewares and required modules will be created for you. Have a look at the created directory.
```bash
-$ cd project-name
+cd project-name
```
to start your Xest API, run
```bash
-$ xx run
+xx run
```
Et voila! You're ready to Xest :)