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

# Configure

**Step 1: As part of the install after EdgeCollector is installed,  EdgeCollector must be configured using the following CLI**

$ cfxedgecollector configure

**Step 2: Directory Structure**

cfxEdgeCollector will be installed under directory /opt/CloudFabrix/cfxEdgeCollector/

As a part of the installation cfxEdgeCollector will create all the following default directories for job and data for the first time when the directories do not exist. The directory structure for EdgeCollector are shown below : 

                             /opt/CloudFabrix/cfxEdgeCollector/

                             |

                             |\_\_ data-dir

                             |\_\_ job-dir

                             |\_\_ exported-dir

                             |\_\_ backup-directory

                             |\_\_ load-profiles (optional)

&#x20;                            |\_\_ \<binaries>

```
$ cfxedgecollector configure --jobdir /opt/CloudFabrix/jobs --datadir /opt/CloudFabrix/data  --exporteddir /opt/CloudFabrix/exporteddata --backupdir /opt/CloudFabrix/backup --loadprofiledir /opt/CloudFabrix/loadprofiles --password abcd123$ --location sanjose  --name ec01
```

**Step 3:  Configure credentials**&#x20;

\
Mandatory attributes  need to  configure  --password, --name, --location

UI  Username  :  cfxcollector &#x20;

UI Password    :   Password&#x20;

Once the users execute the above command,  data will be populated in the default  directory structure as shown above.

**Note: Users can also point cfxEdgeCollector to use custom directories as shown in below CLI.**

```
$ cfxedgecollector configure --jobdir /opt/CloudFabrix/jobs --datadir /opt/CloudFabrix/data  --exporteddir /opt/CloudFabrix/exporteddata --backupdir /opt/CloudFabrix/backup --loadprofiledir /opt/CloudFabrix/loadprofiles --password abcd123$ --location sanjose  --name ec01
```

**Step 4: Enable Firewall to access UI**

**Note: EdgeCollector UI can be access using browser and it is bound to port 8888** &#x20;

Enable firewall to allow port 8888 using the following CLI

```
$ sudo firewall-cmd --add-port=8888/tcp --permanent 
$ sudo firewall-cmd  --reload

```

**Step 5: Verification of cfxEdgeCollector installation**

Once the  cfxEdgeCollector installation is completed, cfxedgecollector CLI is added to the system path. The supported options for cfxedgecollector CLI are as follows.&#x20;

```
$ cfxedgecollector --help
usage: cfxedgecollector [--version] [--start] [--stop] [--delete] [--status]
                        [-h]
                        [{authconfig,collect,configure,export,register,scheduler,status,uninstall,backup,restore,job,jobpoller,jobexecutor}]

positional arguments:
  {authconfig,collect,configure,export,register,scheduler,status,uninstall,backup,restore,job,jobpoller,jobexecutor}
                        Directory name containing job.json and necessary
                        credentials

optional arguments:
  --version             Shows the version information
  --start               Starts the edge collector service, which will provide
                        the UI also sends the Heartbeat to the registered
                        realize setups
  --stop                Stops the edge collector service
  --delete              Deletes the edge collector service
  --status              Details of the edge collector service
  -h, --help            Show this help message and exit.
[macaw@localhost ~]$ 

```

<br>