CLI Commands Reference

OpenRegister provides several CLI commands for administration, debugging, and maintenance tasks. All commands are executed using Nextcloud's 'occ' command-line tool.

Quick Reference

Command	Purpose	Use Case
'openregister:solr:manage'	Production SOLR management	Setup, optimize, maintain SOLR
'openregister:solr:debug'	SOLR debugging	Troubleshoot SOLR issues
Standard Nextcloud OCC	App & system management	Enable/disable, maintenance

Command Execution

Basic Syntax

# From host machine (recommended for WSL/Docker)
docker exec -u 33 <nextcloud-container> php /var/www/html/occ <command>

# From within container
php /var/www/html/occ <command>

# With increased memory limit (for large operations)
docker exec -u 33 <nextcloud-container> php -d memory_limit=4G /var/www/html/occ <command>

Common Container Names

• Development: 'master-nextcloud-1'
• Production: Usually 'nextcloud' or your custom container name
• Find your container: 'docker ps | grep nextcloud'

OpenRegister Commands

1. SOLR Management Command ('openregister:solr:manage')

Purpose: Production-ready SOLR management for setup, optimization, and maintenance.

Available Actions:

Setup

Initialize complete SOLR infrastructure including configSets, collections, and schema.

docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage setup

What it does:

• Creates SOLR configSet
• Creates base collection
• Deploys schema with ObjectEntity fields
• Creates tenant-specific collection
• Validates setup

Optimize

Optimize SOLR index for better query performance.

# Optimize index
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage optimize

# Optimize and commit immediately
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage optimize --commit

When to use: After large bulk imports, during maintenance windows, before high-traffic periods.

Warm

Pre-load SOLR caches for better performance.

docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage warm

When to use: After server restarts, deployments, or SOLR restarts.

Health

Comprehensive health check of SOLR infrastructure.

docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage health

Checks:

• Connection status and response time
• Tenant collection accessibility
• Search functionality
• Document counts
• Service statistics

Schema Check

Validate SOLR schema compatibility with ObjectEntity fields.

docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage schema-check

Validates: All required ObjectEntity fields are present in SOLR schema.

Clear

Clear tenant-specific SOLR index (destructive operation).

# Requires --force flag for safety
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage clear --force

⚠️ Warning: This deletes ALL indexed documents for the current tenant!

Stats

Display detailed SOLR statistics and performance metrics.

docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage stats

Shows:

• Collection information
• Document counts
• Shard information
• Performance metrics
• Search/index timing statistics

2. SOLR Debug Command ('openregister:solr:debug')

Purpose: Debugging and troubleshooting SOLR configuration issues.

Available Options:

# Run all debug tests
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --all

# Show tenant information
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --tenant-info

# Test SOLR setup
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --setup

# Test connection
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --test-connection

# Check cores/collections
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --check-cores

Example Output:

🔍 SOLR Debug Tool - OpenRegister Multi-Tenant
================================================
📋 Tenant Information
  Instance ID: oc6fgt938z8c
  Overwrite Host: http://nextcloud.local
  Generated Tenant ID: nc_f0e53393
  Base Core Name: openregister
  Tenant Specific Core: openregister_nc_f0e53393

🔧 Testing SOLR Setup
  SOLR Configuration:
    Host: nextcloud-dev-solr
    Port: 8983
    Path: /solr
    Core: openregister
    Scheme: http
✅ SOLR setup completed successfully

Command Comparison

Feature	'openregister:solr:manage'	'openregister:solr:debug'
Purpose	Production operations	Development/troubleshooting
Setup	Full production setup	Test setup process
Connection Test	Health check (comprehensive)	Basic connection test
Optimization	✅ Yes	❌ No
Cache Warming	✅ Yes	❌ No
Statistics	✅ Detailed metrics	❌ Basic info only
Use Case	Production deployments	Debugging issues

Database Commands

Standard Nextcloud Commands

# Database status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ db:add-missing-indices
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ db:add-missing-columns
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ db:convert-filecache-bigint

# Maintenance mode
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ maintenance:mode --on
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ maintenance:mode --off

API Testing Commands

Object Operations

# Create test object
docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -X POST \
  -H 'Content-Type: application/json' \
  -H 'OCS-APIREQUEST: true' \
  'http://localhost/index.php/apps/openregister/api/objects/19/105' \
  -d '{"naam": "Test Object", "beschrijving": "Test description"}'

# Get objects
docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -H 'Content-Type: application/json' \
  'http://localhost/index.php/apps/openregister/api/objects?register=19&schema=105'

# Delete object by UUID
docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -X DELETE \
  -H 'OCS-APIREQUEST: true' \
  'http://localhost/index.php/apps/openregister/api/objects/19/105/<uuid>'

Bulk Import Testing

# Get object count before import
before_count=$(docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -H 'Content-Type: application/json' \
  'http://localhost/index.php/apps/openregister/api/objects?register=19&schema=105' | jq -r '.total // 0')
echo "Objects before: $before_count"

# Perform bulk import
docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -X POST \
  -H 'OCS-APIREQUEST: true' \
  'http://localhost/index.php/apps/openregister/api/import/19/105' \
  -F "file=@/var/www/html/apps-extra/openregister/lib/Settings/organisatie.csv"

# Check object count after import
after_count=$(docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -H 'Content-Type: application/json' \
  'http://localhost/index.php/apps/openregister/api/objects?register=19&schema=105' | jq -r '.total // 0')
echo "Objects after: $after_count"
echo "Imported: $(($after_count - $before_count))"

SOLR Direct Testing

Collection Queries

# Test SOLR collection directly
docker exec -u 33 master-nextcloud-1 curl -s \
  "http://nextcloud-dev-solr:8983/solr/openregister/select?q=*:*&rows=10&wt=json" \
  | jq -r '{total: .response.numFound, docs: [.response.docs[]? | {id: .id, name: .name}]}'

# Search for specific content
docker exec -u 33 master-nextcloud-1 curl -s \
  "http://nextcloud-dev-solr:8983/solr/openregister/select?q=name:test&wt=json" \
  | jq .response.docs

# Check SOLR admin APIs
docker exec -u 33 master-nextcloud-1 curl -s \
  "http://nextcloud-dev-solr:8983/solr/admin/collections?action=CLUSTERSTATUS&wt=json" \
  | jq .cluster.collections

Database Inspection Commands

Direct Database Access

# Get database connection info
docker exec -u 33 master-nextcloud-1 php -r "
\$config = include '/var/www/html/config/config.php';
echo 'DB_HOST=' . \$config['dbhost'] . PHP_EOL;
echo 'DB_NAME=' . \$config['dbname'] . PHP_EOL;
echo 'DB_USER=' . \$config['dbuser'] . PHP_EOL;
echo 'DB_PASSWORD=' . \$config['dbpassword'] . PHP_EOL;
"

# Connect to database
docker exec -u 33 master-nextcloud-1 mysql -h master-database-mysql-1 -u nextcloud -pnextcloud nextcloud

# Object count queries
docker exec -u 33 master-nextcloud-1 mysql -h master-database-mysql-1 -u nextcloud -pnextcloud nextcloud -e "
SELECT COUNT(*) as total_objects 
FROM oc_openregister_objects 
WHERE register = 19 AND schema = 105;
"

# Recent objects
docker exec -u 33 master-nextcloud-1 mysql -h master-database-mysql-1 -u nextcloud -pnextcloud nextcloud -e "
SELECT 
    LEFT(id, 8) as short_id,
    name,
    published IS NOT NULL as auto_published,
    created,
    published
FROM oc_openregister_objects 
WHERE register = 19 AND schema = 105 
ORDER BY created DESC 
LIMIT 5;
"

Debugging Commands

System Information

# PHP memory and settings
docker exec -u 33 master-nextcloud-1 php -r "
echo 'PHP Memory Limit: ' . ini_get('memory_limit') . PHP_EOL;
echo 'Current usage: ' . round(memory_get_usage(true)/1024/1024, 2) . 'MB' . PHP_EOL;
echo 'Peak usage: ' . round(memory_get_peak_usage(true)/1024/1024, 2) . 'MB' . PHP_EOL;
"

# Nextcloud status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:list | grep openregister

# Log monitoring
docker logs master-nextcloud-1 --since 10m | grep -i -E 'solr|openregister|error'
docker logs master-nextcloud-1 -f | grep openregister

Performance Monitoring

# Memory usage during operations
docker stats master-nextcloud-1 --no-stream

# Container resource usage
docker exec master-nextcloud-1 top -bn1 | head -20

# Apache processes
docker exec master-nextcloud-1 ps aux | grep apache

App Management Commands

OpenRegister App Commands

# Enable/disable app
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:enable openregister
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:disable openregister

# App information
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:list | grep openregister
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:info openregister

Development Workflow Commands

Complete Testing Sequence

#!/bin/bash
# Complete SOLR and object testing workflow

echo "=== OpenRegister Development Testing Sequence ==="

# 1. Check system status
echo "1. System Status Check..."
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:list | grep openregister

# 2. SOLR debugging
echo "2. SOLR Debug Check..."
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --all

# 3. Test object creation
echo "3. Creating test object..."
uuid=$(docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  -X POST -H 'Content-Type: application/json' -H 'OCS-APIREQUEST: true' \
  'http://localhost/index.php/apps/openregister/api/objects/19/105' \
  -d '{"naam": "CLI Test Object", "beschrijving": "Created via CLI test"}' | jq -r '.id')

echo "Created object: $uuid"

# 4. Check SOLR indexing
echo "4. Checking SOLR indexing..."
sleep 2  # Allow time for indexing
docker exec -u 33 master-nextcloud-1 curl -s \
  "http://nextcloud-dev-solr:8983/solr/openregister/select?q=*:*&wt=json" \
  | jq -r '{total: .response.numFound, sample: [.response.docs[]? | {id: .id, name: .name}] | .[0:3]}'

# 5. Test retrieval
echo "5. Testing object retrieval..."
docker exec -u 33 master-nextcloud-1 curl -s -u 'admin:admin' \
  "http://localhost/index.php/apps/openregister/api/objects/19/105/$uuid" \
  | jq -r '{id: .id, name: .naam, created: ."@self".created}'

echo "=== Testing Complete ==="

Troubleshooting Commands

Common Issues

# Memory exhaustion
docker exec -u 33 master-nextcloud-1 php -d memory_limit=4G /var/www/html/occ <command>

# Permission issues
docker exec master-nextcloud-1 chown -R www-data:www-data /var/www/html/apps-extra/openregister

# Clear caches
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ maintenance:repair
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ files:scan --all

# Reset SOLR connection
docker restart <solr-container-name>
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --setup

Security Notes

Authentication Headers

Always include required headers for API calls:

• -u 'admin:admin' for basic authentication
• -H 'OCS-APIREQUEST: true' for OCS API requests
• -H 'Content-Type: application/json' for JSON payloads

Container Access

• Use -u 33 (www-data user) for PHP commands
• Use root access only when necessary for system changes
• Never expose database credentials in production logs

Performance Optimization

Memory Management

Permanent Memory Limit Increase

The Docker setup has been configured with 4GB PHP memory limit (matching production). To apply these changes:

# 1. Stop the Nextcloud container
docker-compose stop nextcloud

# 2. Start with new configuration
docker-compose up -d nextcloud

# 3. Verify new memory limit
docker exec -u 33 master-nextcloud-1 php -r "echo 'PHP Memory Limit: ' . ini_get('memory_limit') . PHP_EOL;"

Expected Output:

PHP Memory Limit: 4G

Temporary Memory Increase

# Increase PHP memory limit for single command
docker exec -u 33 master-nextcloud-1 php -d memory_limit=4G /var/www/html/occ <command>

# Monitor memory usage during operations
docker exec master-nextcloud-1 bash -c 'while true; do free -h; sleep 5; done' &

Bulk Operations

# Process large imports in chunks
# Use pagination for large datasets
# Monitor system resources during bulk operations

Workflow Examples

Initial Setup Workflow

Complete workflow for setting up OpenRegister with SOLR:

#!/bin/bash
# Initial OpenRegister setup

# 1. Enable the app
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:enable openregister

# 2. Check app status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ app:info openregister

# 3. Setup SOLR infrastructure
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage setup

# 4. Verify SOLR health
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage health

# 5. Warm up caches
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage warm

echo "OpenRegister is ready for use!"

Maintenance Workflow

Regular maintenance tasks:

#!/bin/bash
# Weekly maintenance

# 1. Check SOLR health
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage health

# 2. Optimize index (run during low-traffic hours)
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage optimize --commit

# 3. Display statistics
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:manage stats

# 4. Check system status
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ status

echo "Maintenance complete!"

Debugging Workflow

Troubleshooting when SOLR issues occur:

#!/bin/bash
# Debug SOLR issues

# 1. Run all debug tests
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --all

# 2. Check tenant information
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --tenant-info

# 3. Test connection specifically
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --test-connection

# 4. Check cores/collections
docker exec -u 33 master-nextcloud-1 php /var/www/html/occ openregister:solr:debug --check-cores

# 5. Check logs
docker logs master-nextcloud-1 --since 10m | grep -i solr

echo "Debug information collected!"

Best Practices

Production Recommendations

1. Initial Setup

   • Run 'openregister:solr:manage setup' once during deployment
   • Verify with 'openregister:solr:manage health'
   • Warm caches with 'openregister:solr:manage warm'

2. Regular Maintenance

   • Run 'optimize' weekly or after large imports
   • Check 'health' daily via monitoring
   • Review 'stats' for performance insights

3. Troubleshooting

   • Use 'openregister:solr:debug' for initial diagnostics
   • Check tenant information to verify multi-tenancy setup
   • Test connection when experiencing search issues

Performance Optimization

1. Memory Management

   • Use '-d memory_limit=4G' for bulk operations
   • Monitor memory usage during imports
   • Optimize index after large data changes

2. Cache Warming

   • Warm caches after cold starts
   • Run after major deployments
   • Schedule before high-traffic periods

3. Index Optimization

   • Run during maintenance windows
   • Use '--commit' flag for immediate effect
   • Monitor execution time for large indexes

Security Considerations

1. Container Access

   • Always use '-u 33' (www-data user) for OCC commands
   • Never expose admin credentials in scripts
   • Use root access only when necessary

2. Data Safety

   • Always use '--force' flag for destructive operations
   • Test commands in development first
   • Back up before running 'clear' operations

3. Production vs Development

   • Use 'openregister:solr:manage' for production
   • Use 'openregister:solr:debug' for development only
   • Never run debug commands in production load

Related Documentation

• Nextcloud OCC: Nextcloud OCC Commands
• OpenRegister Features: SOLR Search
• Development: Testing Guide
• Testing: Testing Guide
• RBAC: RBAC Implementation
• Frontend: Frontend Architecture

Changelog

Version 0.2.8

• ✅ Added 'openregister:solr:manage' for production operations
• ✅ Added 'openregister:solr:debug' for troubleshooting
• ✅ Comprehensive command documentation
• ✅ Workflow examples and best practices
• ✅ Performance optimization guidelines