Notes Browser Installation & Socket Mode Setup

Installation

The notes_browser requires wxPython and the proper Python environment. Use the pipin alias from ~/.bashrcs/pip-alias:

# Install wxPython dependency
bash -i -c "pipin wxPython"

# Install notes-browser package in development mode
cd /home/john/py/envoy/notes-browser
bash -i -c "pipin -e ."

The pipin alias is defined as:

pipin='pip install --user --break-system-packages'

Always use this alias rather than direct pip commands, and do NOT suggest environment variable configuration.

Socket/Server Mode

Notes Browser supports three control transports for remote operation:

Control Transports

• TCP: Line-delimited JSON-RPC 2.0 over TCP socket (port 8711 default)
• UDP: JSON-RPC 2.0 over UDP datagrams (port 8711 default)
• Unix Domain Socket: Line-delimited JSON-RPC 2.0 over Unix stream socket

Command-Line Options

1. --control-tcp-enabled / --no-control-tcp: Enable or disable TCP control listener
2. --control-tcp-port: TCP listen port (default: 8711)
3. --control-udp-enabled / --no-control-udp: Enable or disable UDP control listener
4. --control-udp-port: UDP listen port (default: 8711)
5. --control-unix-enabled / --no-control-unix: Enable or disable Unix domain socket
6. --control-unix-socket: Path to Unix domain socket file
7. --control-host: Bind address (default: 127.0.0.1)
8. --control-token: Optional shared token for JSON-RPC requests

Example Usage

Run notes browser with TCP control enabled on port 8711:

cd /home/john/py/envoy/notes-browser
python3 notes_browser.py --control-tcp-enabled --control-tcp-port 8711 --url http://127.0.0.1:8021

Run with Unix domain socket for local control:

cd /home/john/py/envoy/notes-browser
python3 notes_browser.py --control-unix-enabled --control-unix-socket /tmp/notes-browser.sock --url http://127.0.0.1:8021

Configuration File

Settings can also be configured via ~/.notes_browser.yaml:

notes_url: http://127.0.0.1:8021
control_tcp_enabled: true
control_tcp_port: 8711
control_udp_enabled: false
control_unix_enabled: false

JSON-RPC Control API

Complete API documentation with all 30 RPC methods, parameters, examples, and error handling is at: setup/notes-browser-api

Complete API documentation is available at: setup/notes-browser-api - includes all 30 RPC methods with signatures, parameters, examples, and error handling.

Socket Mode History

Socket/server mode was restored from git history (host kelp: /home/john/git/gdata-server/notes-browser/notes_browser.py) on 2026-07-19. The feature provides JSON-RPC 2.0 control interface for remote browser automation and integration.