Update existing documentation: - docs/index.md: refresh main documentation index - docs/manwhere/Usage.md: update manwhere usage instructions Add new documentation: - docs/opencode-gateway-system-settings.md: system settings documentation for opencode-gateway
2.3 KiB
2.3 KiB
opencode-gateway System Settings Documentation
This document describes the system settings that may be modified when using the opencode-gateway setup command in server mode.
Settings Changed by setup Command
Power Management (pmset)
The following power settings may be modified to optimize for server operation:
| Setting | Default | Changed To | Description |
|---|---|---|---|
sleep |
varies | 0 (never) | Prevent system from sleeping |
displaysleep |
varies | 10 (minutes) | Turn off display after 10 minutes |
disksleep |
varies | 10 (minutes) | Spin down disks after 10 minutes |
womp (wake-on-network) |
0 | 1 | Enable wake on network activity |
Desktop vs Laptop: On laptops, settings are applied to both AC (-c) and battery (-b) profiles. Desktops skip battery settings.
Network Settings
- Wake-on-network: Enabled to allow the server to wake from sleep when network activity is detected
How Restoration Works
When you run opencode-gateway down, the system automatically:
- Stops the service
- Restores original power settings from the backup file at:
~/.config/opencode-gateway/.power-backup
Manual Restoration
If needed, settings can be manually restored using pmset:
# View current settings
pmset -g
# Restore specific settings (example values)
sudo pmset sleep 30 # Sleep after 30 minutes
sudo pmset displaysleep 10 # Display sleep after 10 minutes
sudo pmset disksleep 10 # Disk sleep after 10 minutes
sudo pmset womp 0 # Disable wake-on-network
Security Notes
- Settings are backed up before any changes are made
- Backup is stored in your user config directory (
~/.config/opencode-gateway/) - Original settings are automatically restored on
downcommand - Settings persist across reboots until restored
Files Modified
| File | Purpose |
|---|---|
~/.config/opencode-gateway/.power-backup |
Stores original power settings before modification |
~/.config/opencode-gateway/config |
Stores script configuration |
See Also
opencode-gateway setup- Configure server system settingsopencode-gateway stop- Stop service without restoring settingsopencode-gateway down- Stop service and restore settingspmset(1)- macOS power management manual