# Installation

This project requires Docker to be installed on your system. Follow the instructions below based on your operating system.

## Windows

1. Visit the official Docker Desktop website: <https://www.docker.com/products/docker-desktop>
2. Download the Docker Desktop installer for Windows.
3. Run the installer and follow the on-screen instructions to complete the installation.
4. Once Docker Desktop is installed, open a new PowerShell window and run the following command to verify the installation:

```powershell
docker --version
```

## Linux

### Ubuntu

01. Update the package index:
``` bash sudo apt-get update ```
02. Install the required packages:
```bash sudo apt-get install apt-transport-https ca-certificates curl software-properties-common```

03. Add Docker's official GPG key:
```bash curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -```

4. Add the Docker repository:
```bash sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"```

5. Install Docker:
```bash   sudo apt-get install docker-ce```

6. Verify the installation:
```bash  sudo docker run hello-world```

### Other Linux distributions

For other Linux distributions, please refer to the official Docker installation guide: <https://docs.docker.com/engine/install/>

## Clone the Repository

1. Open a terminal and navigate to the directory where you want to clone the repository.

2. Run the following command to clone the repository:

   ```bash
   git clone https://github.com/dorel14/3CX-Cdr-Tcp-Server.git

   ```

3. Once the cloning is complete, navigate to the project directory:

```bash
cd 3CX-Cdr-Tcp-Server
```

## Create .env File

 1. In the project directory, you will find a file named `.env_template`.
 2. Create a new file named `.env` by copying the contents of `.env_template`:  
   ```bash cp .env_template .env```

 3. Open the .env file in a text editor and update the values according to your environment settings. This file contains configuration variables required for the project to run correctly. [Configuration](02-Configuration.md)