Configuration

Fanar works out of the box with no configuration. The only setting you may need to change is the port if 23517 conflicts with another process.

Default port

The Fanar desktop app listens on localhost:23517 by default. All official client libraries default to this address.

Changing the port

Open the Fanar desktop app and go to Settings. Change the port and restart — the new port is persisted across sessions.

Node.js

Call configure() once at startup, before any fanar() calls.

import { configure } from '@fanar-app/fanar/config'

configure({
  host: 'localhost',  // default
  port: 23517,        // default
})

NestJS

Pass options to forRoot() or forRootAsync().

FanarModule.forRoot({
  enabled: process.env.NODE_ENV === 'development',
  host: process.env.FANAR_HOST ?? 'localhost',
  port: Number(process.env.FANAR_PORT ?? 23517),
})

Laravel

# .env
FANAR_HOST=127.0.0.1
FANAR_PORT=23517
FANAR_ENABLED=true

PHP

<?php
use Fanar\Fanar;

Fanar::configure([
  'host' => '127.0.0.1',
  'port' => 23517,
]);

SSH tunnel

If your app runs on a remote server (staging, CI, Docker) and you can't set a direct LAN IP, use Fanar's built-in SSH tunnel instead. Open Preferences → SSH Tunnel, enter your server credentials, and Fanar forwards the port over SSH automatically. See the SSH Tunnel page for setup details.

Remote machines

If Fanar runs on a different machine (e.g. your laptop while code runs in a VM or container), set the host to the LAN IP of the machine running the desktop app.

# Node.js
configure({ host: '192.168.1.10', port: 23517 })

# Laravel .env
FANAR_HOST=192.168.1.10

Make sure the Fanar port is reachable from the client machine (firewall / Docker port binding).