Install on TrueNAS SCALE

Determine Your Storage Path

You need to identify where to store persistent data. Common options:

• Apps pool (recommended): /mnt/[pool-name]/ix-applications/lens/...
  • Find your Apps pool in: Apps > Settings > Advanced Settings > Pool
• Custom dataset: /mnt/[pool-name]/[dataset-name]/lens/...

Create Required Directories

Open the TrueNAS Shell (System Settings > Shell) or SSH into your TrueNAS host:

# Replace /mnt/[your-pool] with your actual Apps pool path
# Example: /mnt/tank/ix-applications/lens

# Create MongoDB data directory
mkdir -p /mnt/[your-pool]/ix-applications/lens/mongodb_data

# Create uploads directory
mkdir -p /mnt/[your-pool]/ix-applications/lens/uploads_data

# Set MongoDB directory ownership (MongoDB runs as user 568:568)
chown -R 568:568 /mnt/[your-pool]/ix-applications/lens/mongodb_data

Verify Directory Permissions

# Check MongoDB directory
ls -la /mnt/[your-pool]/ix-applications/lens/mongodb_data

# Check uploads directory
ls -la /mnt/[your-pool]/ix-applications/lens/uploads_data

Open Custom App YAML Editor

1. Log in to your TrueNAS SCALE web interface
2. Navigate to Apps > Discover Apps
3. Click the three-dot menu (⋮) next to Custom App
4. Select Install via YAML from the menu
5. A YAML editor will open

Paste Configuration

1. Copy the contents of lens-truenas-app.yaml
2. Paste it into the YAML editor
3. Important: Before proceeding, you must update the configuration (see Configuration below)

Update Configuration

Before deploying, update the following in the YAML:

Storage Paths

Replace all instances of /mnt/[your-pool]/ix-applications/lens with your actual storage path:

volumes:
  - /mnt/[your-pool]/ix-applications/lens/mongodb_data:/data/db
  - /mnt/[your-pool]/ix-applications/lens/uploads_data:/app/uploads

Network Configuration

Update the HOSTNAME, FRONTEND_URL, and VITE_APP_API_URL environment variables:

environment:
  - HOSTNAME=192.168.1.100  # Replace with your TrueNAS IP or hostname
  - FRONTEND_URL=http://192.168.1.100:30306  # Update accordingly
  - VITE_APP_API_URL=http://192.168.1.100:30305/  # Backend API URL (used by both frontend and backend)

Admin Credentials

environment:
  - DEFAULT_ADMIN_EMAIL=admin@local.test  # Change this
  - DEFAULT_ADMIN_USERNAME=admin  # Change this
  - DEFAULT_ADMIN_PASSWORD=admin@local.test  # Change this
  - DEFAULT_ADMIN_NAME=Administrator

SMTP Configuration (Optional)

If you want email functionality, configure SMTP:

environment:
  - SMTP_HOST=smtp.example.com
  - SMTP_PORT=465
  - SMTP_USER=your-email@example.com
  - SMTP_PASS=your-password
  - SMTP_FROM=noreply@example.com

Port Configuration

Adjust ports if they conflict with other services:

• Backend: 30305:30305 (change this port if needed)
• Frontend: 30306:80 (change first number if needed)
• MongoDB: 27018:27017 (change first number if needed)

Deploy

1. Review all configuration changes
2. Click Save to deploy the application
3. TrueNAS will start pulling images and creating containers

Monitor Deployment

1. Navigate to Apps
2. You will see all running instances listed
3. Check the status of your Lens app
4. Select the Lens app to view the status of all Lens services:
   • Wait for all services to show “Running” status
   • Check logs if any service fails to start