Skip to main content

Customization

Webshell Configuration Guide

Per-user web terminal preferences are stored in ~/.config/webshell/.


Directory Structure

~/.config/webshell/
├── config.json      # Theme, font size, and cursor settings
└── font.woff2       # (Optional) Local custom font file (.woff2, .ttf, or .otf)

config.json Options

Key Type Default Description fontFamily String 'JetBrains Mono', monospace Font family stack fontSize Number 15 Font size in pixels cursorStyle String "block" Cursor shape ("block", "underline", or "bar") cursorBlink Boolean true Enable or disable cursor blinking theme Object See below Color palette overrides

Theme Options (theme object)

Key Description background Terminal background color (e.g. "#000000") foreground Default text color (e.g. "#e0e0e0") cursor Cursor color (e.g. "#ffffff") black – white Standard 8 ANSI colors brightBlack – brightWhite High-intensity 8 ANSI colors

Example ~/.config/webshell/config.json

{
  "fontFamily": "'JetBrains Mono', 'Fira Code', monospace",
  "fontSize": 15,
  "cursorStyle": "block",
  "cursorBlink": true,
  "theme": {
    "background": "#000000",
    "foreground": "#e0e0e0",
    "cursor": "#00ff00",
    "green": "#00ff00",
    "cyan": "#00ffff"
  }
}

Using Local Font Files

Place your font file in ~/.config/webshell/ as one of the following:

    font.woff2 (Recommended) font.ttf font.otf

    The webshell will automatically encode and load your font file into the web browser upon login.