Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GDE is a solution that allows indexing of data on endpoints and/or fileservers without defining a share. It runs on Windows, Linux, macOS, and Pardus environments.

The GDE agent indexes/discovers many PCs or FileServers w/o defining a share. The GDE agent runs on Windows, Linux, or MacOS.

GEODI may discover FileServers if there is a share. Then, GDE is not required.

Info

GDE crawls the EndPoint or FileServer and sends selected files to a GEODI Server. This way, you can discover and search local files w/o sharing any folder. GDE continuously crawls every 3 hours to find changed files.

Info

With the GEODI Classifier, it is possible to classify the local files remotely.

Info

After discovery, it is possible to remediate the local files remotely.

Info

When a file is deleted from GDE, running "Purge Deleted Content" will remove the file from the GEODI index.

Installation and Configuration

Info

A configuration file on the GEODI server determines which local folders and file types to include. This configuration may be customized by client IP, ClientUser, or ClientMachine name. So, you may target a different area for each FileServer or client.

...

The Agents can be manually installed on FileServers or EndPoints. But if you have many EndPoints, using a tool like ManageEngine or SCCM for deployment is suggested.

GDE agent software updates are auto. It may be set to update from a local source.

...

GEODI can discover and analyze data from many sources without requiring any agents.
However, in cases where:

  • Network shares are not available

  • Agentless access is not preferred

  • There are many distributed endpoints

...the GDE (GEODI Desktop Explorer) agent is recommended.

The GDE agent enables powerful on-endpoint actions, including:

  • Secure Delete

  • Quarantine

  • Classification

  • Masking

This makes GDE essential for extending GEODI’s reach to remote endpoints while maintaining centralized control and compliance.

Tip

Connection Requirements for GDE (GEODI Desktop Explorer)

To deploy and connect GDE agents across multiple clients, the following prerequisites must be met:

🛠️ Deployment Tools & User Permissions

  • Use tools like ManageEngine, SCCM, or similar for mass deployment

  • A privileged user account is required for installation

  • The Project Wizard → Feed Source → GDE Connection section auto-generates all necessary MSI deployment parameters

🔐 Authentication

  • A GEODI user with feed permissions is required

  • This user is only needed for generating the connection token

🌐 Network Requirements

  • Client machines must be able to access the GEODI server

  • GEODI server must be able to access the clients, and the default port 1982 (customizable) must be open in both directions

📁 Content Scope

  • Define which directories and file types to be discovered on client machines

  • Default paths can be adjusted per client in the setup configurations

Supported Platforms → Windows, Linux, MacOS ve Pardus

Ajan güncellemeleri → Windows Clientlar için tamamen otomatik

MSI Link<geodi_url>/GUI/Agents/GDE/GEODI.DesktopExplorer.MSI → For Windows clients, GDE agents are automatically updated. This link is automatically populated during GEODI Discovery module setup. Windows agents regularly check this location and self-update when a new version is available.

Service Installation → On Windows file servers, the GDE agent can be installed as a Windows Service, enabling continuous background operation for server-side discovery and actions.

Agent Monitoring → Active agents can be tracked via the GDE Agent Monitoring Panel:
🔗 Monitor Active Agents

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printabletrue

...

Client Monitoring

...

Gliffy
imageAttachmentIdatt4336386146
macroIdc02c52c0-32db-418a-8a1e-64c4cfe9a700
baseUrlhttps://decesw.atlassian.net/wiki
nameGDE-EN
diagramAttachmentIdatt4336648300
containerId3972202552
timestamp1702733720298

Installation Checklist

...

Subject

...

Description

...

Create a new project or choose an existing project to index files.

...

A separate project is OK for discovery purposes, but adding PCs to an existing project is better if you have Enterprise Search.

This project URL must be accessible from the EndPoints.

The GDE recognizer(from discovery IT group), must be used in the project.

...

Create a token

...

Follow the procedure on this page to get the Token.

Generating a GEODI Token

As a best practice, we suggest you create a separate user for the Token. And token users' passwords should not be changed.

...

Follow the procedures for different OSs

...

These pages will lead you to each OS.

Child pages

...

GDE Configuration Settings

...

The settings determine which local folders and file types to discover. There may be a single setting for all, or you may customize it by clients.

image-20241219-105355.pngImage Added

GDE configuration settings

Settings should be GEODI server <GEODI_APP>/Settings/Geodi.DesktopExplorer folder named default.json. Installed GDEs will automatically retrieve this setting in about an hour.

  • Any changes will be effective in about an hour. You may change the settings while GEODI is running.

  • To define different rules for each machine, you may use additional files named

    • <ClientIP>.json

    • <ClientUserName>.json

    • <ClientMachineName>.json.

Code Block
languagejson
{
  "FolderList": ["%UserProfile%"],// "*" scan all directory //
  "ExplorerPort": 1982,
  "IgnoreFiles":["*.MP4","*.MOV","*.MP3"],
  "MetaData": {
	"LDAPDN":"=d.CurrentUser!=null?d.CurrentUser.DistinguishedName:null",
	"IP":"=d.ClientIP",
	"ComputerName":"=d.ClientMachineName",
	"UserName":"=d.ClientUserName"
	}
}

Setting Name

Type

Description

FolderList

string[]*

Used to specify the folders to be scanned. Folders can be identified by separating them with ",".Windows, MacOS, and Linux client folders can be used interchangeably.

The default directory is %UserProfile% ,\\Users, \\Home(includes documents, downloads, desktops, etc.).

Values are case-sensitive. Subdirectories can also be defined as %UserProfile%\\Desktop.

You can use ["*"] to scan all disks.

ExplorerPort

int

The default is 1982.

Alternatively, you may set the port value to 0. Discovery and search will be fine, but GEODI can not open the local files in this case.

EnableLDAP

bool

If a true value is given, LDAP authorizations of the files are also indexed.

Default value: false

IgnoreFolders

string[]

List of folders to ignore. * is accepted. Used in combination with the settings under Geodi Settings/IgnoreFolders.

Example: ["*:\\data","C:\User*"]

Default value: null

(info) GEODI central file/folder ignore rules always take precedence. The restrictions specified within the settings are applied additionally.

(info) By default, to safeguard the network resource, only the name and date of files larger than 100MB are indexed. This limit is set to 500MB for compressed file contents. These values can be modified on the GEODI server.

IgnoreFiles

string[]

List of folders to ignore. * is accepted and used with the settings under Geodi Settings/IgnoreFileTypes.

Default value:["*.MP4","*.MOV","*.MP3"]

(info) GEODI central file/folder ignore rules always take precedence. The restrictions specified within the settings are applied additionally.

(info) By default, to safeguard the network resource, only the name and date of files larger than 100MB are indexed. This limit is set to 500MB for compressed file contents. These values can be modified on the GEODI server.

Metadata

You can define metadata for parsing files from clients. These metadata are specified in the settings file. The values used in the default settings can be seen in the example file.

Searching with metadata is done with <metaname>:<value> Example IP:192.168.1.1

The defined metadata and values will be visible in the GEODI search interface.

Troubleshooting

Expand
titleIndexing does not start
  1. Check if the client has access to the GEODI Server. GEODI should be accessible through a browser on the client. Enter the GEODI address in a browser on the client; there should be access.

  2. The GEODI server should be accessible from the client's GDE. Using a browser on the client, enter <ClientIP>:<1982>/DEW?op=GetLastError. If everything is fine, it should return null. The ExplorerPort specified in GDE rules, e.g., ExplorerPort=1982 (or the chosen port), should be open.

  3. Inspect the Firewall, Antivirus, or any similar tool to ensure there is no blocking mechanism preventing communication.

  4. Check if the client machine is operational. GDE should be installed and running (Geodi.Desktopexplorer.exe should be in the task list).

  5. Verify the status of the received TOKEN: <GEODI_URL>/API/token_parser.html.

  6. Examine the Agent Management Panel; if the endpoint's status looks good, waiting for a while may resolve the issue. The GEODI Server queues incoming data, so the files at the endpoint might not be due yet.

  7. If everything seems correct but data is still not coming through, check the FolderList and IgnoreFolders values in the GDE rules.

  8. If you are not receiving the expected file type, ensure that the extension is not listed in the IgnoreFiles value in the GDE rules.

...

Expand
titleWhat happens if the endPoint is formatted?
  1. Install the GDE as usual. The endpoint will be treated as new. The old data is preserved.

GDE

...

Settings should be GEODI server <GEODI_APP>/Settings/Geodi.DesktopExplorer folder named default.json. Installed GDEs will automatically retrieve this setting in about an hour.

  • Any changes will be effective in about an hour. You may change the settings while GEODI is running.

  • To define different rules for each machine, you may use additional files named

    • <ClientIP>.json

    • <ClientUserName>.json

    • <ClientMachineName>.json.

Code Block
languagejson
{
  "FolderList": ["%UserProfile%"],// "*" scan all directory //
  "ExplorerPort": 1982,
  "IgnoreFiles":["*.MP4","*.MOV","*.MP3"],
  "MetaData": {
	"LDAPDN":"=d.CurrentUser!=null?d.CurrentUser.DistinguishedName:null",
	"IP":"=d.ClientIP",
	"ComputerName":"=d.ClientMachineName",
	"UserName":"=d.ClientUserName"
	}
}

...

Setting Name

...

Type

...

Description

...

FolderList

...

string[]*

...

Used to specify the folders to be scanned. Folders can be identified by separating them with ",".Windows, MacOS, and Linux client folders can be used interchangeably.

The default directory is %UserProfile% ,\\Users, \\Home(includes documents, downloads, desktops, etc.).

Values are case-sensitive. Subdirectories can also be defined as %UserProfile%\\Desktop.

You can use ["*"] to scan all disks.

...

ExplorerPort

...

int

...

The default is 1982.

Alternatively, you may set the port value to 0. Discovery and search will be fine, but GEODI can not open the local files in this case.

...

EnableLDAP

...

bool

...

If a true value is given, LDAP authorizations of the files are also indexed.

Default value: false

...

IgnoreFolders

...

string[]

...

List of folders to ignore. * is accepted. Used in combination with the settings under Geodi Settings/IgnoreFolders.

Example: ["*:\\data","C:\User*"]

Default value: null

(info) GEODI central file/folder ignore rules always take precedence. The restrictions specified within the settings are applied additionally.

(info) By default, to safeguard the network resource, only the name and date of files larger than 100MB are indexed. This limit is set to 500MB for compressed file contents. These values can be modified on the GEODI server.

...

IgnoreFiles

...

string[]

...

List of folders to ignore. * is accepted and used with the settings under Geodi Settings/IgnoreFileTypes.

Default value:["*.MP4","*.MOV","*.MP3"]

(info) GEODI central file/folder ignore rules always take precedence. The restrictions specified within the settings are applied additionally.

(info) By default, to safeguard the network resource, only the name and date of files larger than 100MB are indexed. This limit is set to 500MB for compressed file contents. These values can be modified on the GEODI server.

...

Metadata

...

You can define metadata for parsing files from clients. These metadata are specified in the settings file. The values used in the default settings can be seen in the example file.

Searching with metadata is done with <metaname>:<value> Example IP:192.168.1.1

The defined metadata and values will be visible in the GEODI search interface.

GDE API

You may use a browser to make these calls.

<ClientIP>:<1982>/DEW?op=GetStatus

...

Gets the status of GDE Agent

{"StatusText":"","RequestCount":0,"FileCount":0,"SendCount":0,"IgnoreCount":0,"Server":"<GEODI_URL>"}

(info) Default port = 1982, may be different

<ClientIP>:<1982>/DEW?op=GetLastError

...

Gets the GDE agent errors.

If no error, retuns null. Else

{"Server":"<GEODI_URL>", "LastErrorTime": {}, "LastError" : "", "TotalErrorCount": n}

...

  1. A user with access to the source that GDEs will feed into logs in. Alternatively, a token is used on the token interface.

    The interface on page Generating a GEODI Token is opened.

    Feed is activated. "Edit AllowList" is clicked under AllowList, and the content source to which GDE will send our files is selected from the list that appears.

    GEODI_URL and GEOD_TOKEN can be obtained by selecting Feed Source from Resources in the Project wizard. The project name must be given before adding this source.

...

API

You may use a browser to make these calls.

<ClientIP>:<1982>/DEW?op=GetStatus

Gets the status of GDE Agent

{"StatusText":"","RequestCount":0,"FileCount":0,"SendCount":0,"IgnoreCount":0,"Server":"<GEODI_URL>"}

(info) Default port = 1982, may be different

<ClientIP>:<1982>/DEW?op=GetLastError

Gets the GDE agent errors.

If no error, retuns null. Else

{"Server":"<GEODI_URL>", "LastErrorTime": {}, "LastError" : "", "TotalErrorCount": n}

Installing GDE as a Windows Service

This option is used to index/discover FileServers with GDE.

Info

Requirements for Installation

In addition to the Windows MSI requirements:

  1. The Windows Service user must have read-only access to the FileServer directories.

  2. A separate configuration file must be created under the GEODI Server for each File Server to define the directories to be indexed and other rules. Details are provided on the main page..

After installing GDE on Windows, it can be turned into a service using the WindowsServiceInstall.bat file located in the same directory.

  1. The service mode can be removed using the WindowsServiceUninstall.bat file.

  2. When running in service mode, no logged-in user is required for the service to function.

MSI Parameters for ManageEngine and Similar Tools

When deploying the GDE agent using ManageEngine, SCCM, or similar tools, you’ll need to provide specific MSI installation parameters.

💡 Good news:
The GDE interface automatically generates these parameters based on your project and feed settings. Copy and paste the generated command line into your deployment tool.

This includes:

  • GEODI server address

  • Connection token

  • Desired scan directories

  • Optional custom port or labels

✅ Just run the MSI with the generated line—no manual editing needed.

Parametre

Açıklama

GEODI_URL=

When configuring GDE agents, you must provide the GEODI server address.

🔐 Best Practice:
Use a secure (HTTPS) address with proper DNS and SSL configuration to ensure encrypted communication and trust between endpoints and the GEODI server.

Requirements:

  • The address should be publicly resolvable if endpoints are outside the network

  • An SSL certificate should be installed on the GEODI server

  • Avoid using IP addresses or unsecured HTTP links in production environments

GEODI_WSNAME=

Workspace Name to Feed

GEODI_TOKEN=

The MSI installation parameters for GDE are automatically generated, including a connection token linked to the GEODI user who created it.

⚠️ Important:
The password of the user who generated the token must not change.
If it changes:

  • The token becomes invalid

  • A new token must be generated

  • All previously installed agents may need to be reinstalled or reconfigured

✅ To avoid disruptions:

  • Use a dedicated service account for token generation

  • Keep the password secure and unchanged

PDQ , ManageEngine, SCCM gibi bir araç ile dağıtım için aşağıdaki komutlar kullanılabilir.

İşlem

Komut

Notlar

Install

"GEODI.Classifier.msi" /quiet GEODI_URL="https://icdemo.dece.com.tr/" GEODI_WSNAME="PII" GEODI_TOKEN="EAAAAL%%2FcQ9RvjWM…"

All params are auto-generated by GEODI. We suggest using those params.

Uninstall

msiexec.exe /x "GEODI.DesktopExplorer.msi" /qn /norestart

You do not need the MSI package to uninstall. Check the PowerShell documentation.