Documentation

Everything you need to deploy and configure Datieve.

Quick Start

Get your license key

After purchasing, you'll receive a license key via email. Keep it handy—you'll enter it in the agent's admin panel.

Deploy the agent

Run the agent on your NAS using Docker:

docker run -d \
  --name datieve-agent \
  -p 9999:9999 \
  -v /path/to/your/files:/data \
  -v datieve-data:/var/lib/datieve \
  datieve/agent:latest

Replace /path/to/your/files with the directory you want to index.

Access the admin panel

Open http://your-nas-ip:9999 in your browser. You'll be prompted for an admin token—check the container logs for the auto-generated token:

docker logs datieve-agent | grep "Admin token"

Enter your license key

In the admin panel, go to Settings and enter your license key. The agent will validate it and begin indexing.

Add folders to index

In the admin panel, add the folders you want to index. These should be paths inside the container (e.g., /data/projects).

Create users

Add employees by email. They'll activate their account on first login by setting a password.

Install the desktop app

Download the desktop app for your platform. On first launch, enter your NAS address and log in.

Configuration

Environment Variables

The agent can be configured via environment variables:

Variable	Default	Description
DATIEVE_PORT	9999	Port for WebSocket and admin panel
DATIEVE_DATA_DIR	/var/lib/datieve	Where the database and config are stored
DATIEVE_SYNC_INTERVAL	60	Minutes between delta scans

Docker Compose Example

For more complex setups, use Docker Compose:

version: '3.8'
services:
  datieve:
    image: datieve/agent:latest
    container_name: datieve-agent
    restart: unless-stopped
    ports:
      - "9999:9999"
    volumes:
      - /mnt/nas/projects:/data/projects:ro
      - /mnt/nas/archive:/data/archive:ro
      - datieve-data:/var/lib/datieve
    environment:
      - DATIEVE_SYNC_INTERVAL=30

volumes:
  datieve-data:

Note: Mount volumes as read-only (:ro) since Datieve only reads files.

User Management

Adding Users

In the admin panel, go to Users and click "Add User". Enter their name and email. The user will be created in "pending" status.

On first login, the user enters their email in the desktop app. The app detects they're pending and prompts them to set a password.

Bulk Import

Import multiple users from a CSV file with columns: name,email

John Smith,john@company.com
Jane Doe,jane@company.com
Bob Wilson,bob@company.com

Groups and Permissions

Create groups to organize folder access:

Create a group (e.g., "Engineering")
Add folder paths the group can access (e.g., "/data/projects/engineering")
Add users to the group

Users inherit access from all groups they belong to. Search results are automatically filtered to only show accessible files.

Troubleshooting

Agent won't start

Check the logs: docker logs datieve-agent. Common issues: port already in use, volume permissions, missing license key.

Desktop app can't connect

Verify the NAS IP is reachable from the workstation. Check that port 9999 is open in your firewall. Try connecting with the IP address instead of hostname.

Files not appearing in search

Ensure the folder is added in the admin panel. Check that the user has group access to the folder. Wait for the next delta scan or trigger one manually.

License validation failed

Verify the license key is entered correctly. Check that the agent can reach the internet for daily check-ins. Contact support if the issue persists.

API Reference

The agent exposes a WebSocket API for programmatic access. Connect to ws://your-nas:9999/ws.

Authentication

First message must be an auth request:

{
  "action": "auth",
  "data": {
    "email": "user@company.com",
    "password": "..."
  }
}

Search

{
  "action": "search",
  "data": {
    "Query": "contract",
    "Limit": 100,
    "Offset": 0
  }
}

List Folder

{
  "action": "list_folder",
  "data": {
    "Path": "/data/projects"
  }
}

Need help?

Contact support →