KLD997/aurion-training-extra

OpenClaw FreeBSD Port

This directory contains the FreeBSD port files for OpenClaw, a personal assistant application.

Directory Structure

ports/openclaw/
├── Makefile              # Port configuration and build instructions
├── distinfo             # Checksum file (SHA256, SIZE)
├── pkg-descr            # Short package description
├── pkg-plist            # File list with installation details
├── files/
│   ├── openclaw.in      # rc.d service script template
│   └── openclaw.conf.sample  # Sample configuration file
└── README.md            # This file

Files Overview

Makefile

• PORTNAME: openclaw
• PORTVERSION: 1.0.0
• CATEGORIES: sysutils, www
• LICENSE: MIT
• Node.js Version: node20 (Node.js 20.x)
• Installation Path: /usr/local/lib/openclaw
• User/Group: openclaw (created automatically)
• RC Script: openclaw

Key variables:

• Uses npm for dependency management
• Installs production dependencies only
• Creates openclaw user and group
• Sets up rc.d service script

pkg-descr

Package description displayed during installation. Includes:

• Brief overview of OpenClaw
• Key features
• Link to GitHub repository

pkg-plist

Package file list using standard FreeBSD conventions:

• %%PORTNAME%% macros for dynamic path substitution
• Directory ownership settings for openclaw user/group
• Staged installation (STAGEDIR)
• Configuration file marked as @sample (not overwritten on upgrades)
• Log, cache, and runtime directories with proper permissions

distinfo

Contains checksum information:

• Current Status: Placeholder values
• Update Method: Run make makesum after fetching the actual source
• This will automatically generate correct SHA256 and SIZE values

openclaw.in (rc.d script)

FreeBSD daemon script located at files/openclaw.in:

• Installed to /usr/local/etc/rc.d/openclaw
• Configurable via /etc/rc.conf:
  • openclaw_enable=YES to start automatically
  • openclaw_user (default: openclaw)
  • openclaw_group (default: openclaw)
  • openclaw_home (default: /var/lib/openclaw)
  • openclaw_flags (default: "gateway")
• Creates required directories with proper permissions
• Manages PID file at /var/run/openclaw/openclaw.pid

openclaw.conf.sample

Sample configuration file:

• Copied to /usr/local/etc/openclaw.conf.sample
• Contains basic gateway and agent settings
• Users should copy to /etc/openclaw.conf and customize

Usage in FreeBSD Ports Tree

Installation Steps:

1. Place port in tree:

   cp -r ports/openclaw /usr/ports/sysutils/
   

2. Generate checksums (after obtaining source):

   cd /usr/ports/sysutils/openclaw
   make makesum
   

   This updates distinfo with actual SHA256 and SIZE values.

3. Build and install:

   cd /usr/ports/sysutils/openclaw
   make install clean
   

4. Enable in rc.conf (optional, for automatic startup):

   echo 'openclaw_enable=YES' >> /etc/rc.conf
   

5. Start the service:

   service openclaw start
   

Directory Permissions

The port automatically creates:

• /var/lib/openclaw/ - Data directory (openclaw:openclaw)
• /var/log/openclaw/ - Log directory (openclaw:openclaw)
• /var/cache/openclaw/ - Cache directory (openclaw:openclaw)
• /var/run/openclaw/ - Runtime directory (openclaw:openclaw)

Dependencies

• Runtime: node20 (Node.js 20.x)
• Build: npm (included with node20)

Compliance

This port follows FreeBSD Ports Guidelines:

• ✅ Proper PORTNAME, PORTVERSION, CATEGORIES
• ✅ LICENSE and LICENSE_FILE declarations
• ✅ Staged installation (STAGEDIR)
• ✅ User/Group management
• ✅ RC script support
• ✅ Sample configuration handling
• ✅ Proper file list (pkg-plist)
• ✅ Checksum file (distinfo)

Notes for Maintainers

1. Updating Source URL: Modify MASTER_SITES and DISTFILES in Makefile
2. Version Bumps: Update PORTVERSION and run make makesum
3. Configuration Changes: Update pkg-plist and files/* as needed
4. Testing: Use poudriere for build testing before submission

Next Steps

After placing in ports tree:

1. Verify build: make describe
2. Check dependencies: make build-depends-list
3. Run checks: portlint
4. Test installation: make install -DINSTALL_AS_USER
5. Verify service: service openclaw status

References

• FreeBSD Ports Developer's Handbook: https://docs.freebsd.org/en/books/porters-handbook/
• Node.js Port: https://www.freshports.org/www/node20/
• rc.d scripts guide: https://docs.freebsd.org/en/articles/rc-scripting/