> For the complete documentation index, see [llms.txt](https://docs.cloudfabrix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloudfabrix.io/cfx-aia/enterprisediscovery/cfxedgecollector/installation.md).

# Deployment of cfxEdgeCollector

The following are pre-requisites for the deployment of cfxEdgeCollector.

1. Virtual Machine  or Bare Metal Host
2. CentOS/RHEL Operating System - 7.6 or above
3. Docker Software - 18.03.1-ce or above
4. Virtual Machine or Bare metal server resource requirements
   1. CPU -- 2 vCPU
   2. RAM -- 8GB
   3. Storage -- 50GB
5. Sudo privileges to the user
6. Configure CentOS operating system to allow port 8888 on the host (using firewall command).
7. CloudFabrix alternatively provides a VMWare based virtual machine (OVF) that can be used for deploying cfxEdgeCollector.

#### Installation of cfxEdgeCollector

Download the cfxEdgeCollector software package to the user's home directory. The filename and format is cfxedgecollector-\<version-number>.tar.gz (e.g. cfxedgecollector-1.0.30.tar.gz).&#x20;

Run the below command to install cfxEdgeCollector software. (Note: Replace the cfxEdgeCollector software package file name with an approrpiate one)

```
sudo pip install cfxedgecollector-1.0.30.tar.gz
```

Create the following directory structure on the system where cfxEdgeCollector will be installed.

* Job Directory (**jobs**) - cfxEdgeCollector uses this directory to store all user-defined job configuration.
* Data Directory (**data**) - cfxEdgeCollector uses this directory to store all the collected inventory data of a job.
* Exported Directory (**exporteddata**) -  cfxEdgeCollector uses this directory to store inventory data that will be exported to back-end applications (cfxAIA).
* Backup Directory (**backup**) - cfxEdgeCollector uses this directory to store backup data.
* Config Directory (**config**) - cfxEdgeCollector uses this directory to store customer configurations&#x20;

Execute the following commands to create the directories.

```
mkdir -p /opt/CloudFabrix/jobs
mkdir -p /opt/CloudFabrix/data
mkdir -p /opt/CloudFabrix/exporteddata
mkdir -p /opt/CloudFabrix/backup
mkdir -p /opt/CloudFabrix/config
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cloudfabrix.io/cfx-aia/enterprisediscovery/cfxedgecollector/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.