{"id":42597788,"url":"https://github.com/ghostbsd/xconfig","last_synced_at":"2026-05-02T05:13:29.716Z","repository":{"id":40330159,"uuid":"150604372","full_name":"ghostbsd/xconfig","owner":"ghostbsd","description":"xconfig is an automation tool to set up X11 for GhostBSD","archived":false,"fork":false,"pushed_at":"2025-12-03T01:59:57.000Z","size":159,"stargazers_count":5,"open_issues_count":0,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-12-05T07:15:14.572Z","etag":null,"topics":["automation"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ghostbsd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"patreon":"GhostBSD","custom":["https://www.ghostbsd.org/donate"]}},"created_at":"2018-09-27T14:56:48.000Z","updated_at":"2025-12-02T10:49:48.000Z","dependencies_parsed_at":"2025-01-11T16:24:55.514Z","dependency_job_id":"a8b02cee-2efd-4f80-a6d1-2ac63a0cbaa9","html_url":"https://github.com/ghostbsd/xconfig","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/ghostbsd/xconfig","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostbsd%2Fxconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostbsd%2Fxconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostbsd%2Fxconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostbsd%2Fxconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghostbsd","download_url":"https://codeload.github.com/ghostbsd/xconfig/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostbsd%2Fxconfig/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28857198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T22:56:21.783Z","status":"ssl_error","status_checked_at":"2026-01-28T22:56:00.861Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation"],"created_at":"2026-01-29T00:12:50.694Z","updated_at":"2026-01-29T00:12:50.777Z","avatar_url":"https://github.com/ghostbsd.png","language":"Shell","funding_links":["https://patreon.com/GhostBSD","https://www.ghostbsd.org/donate"],"categories":[],"sub_categories":[],"readme":"# xconfig\n\n**Intelligent X11 Configuration Tool for GhostBSD**\n\n[![GhostBSD](https://img.shields.io/badge/GhostBSD-25.x%2B-blue.svg)](https://ghostbsd.org/)\n[![License](https://img.shields.io/badge/License-BSD--2--Clause-green.svg)](LICENSE)\n[![Shell](https://img.shields.io/badge/Shell-POSIX%20sh-lightgrey.svg)](https://en.wikipedia.org/wiki/POSIX)\n\n`xconfig` is a comprehensive X Window System configuration tool for GhostBSD/FreeBSD. It performs intelligent hardware detection, installs the right drivers, and applies optimized Xorg configurations for physical GPUs and common hypervisors. It includes an interactive **bsddialog**-based menu for manual selection.\n\n---\n\n## Supported Hardware \u0026 Platforms\n\n### GPUs\n\n* **Intel**: `i915kms` (auto or with external config)\n* **AMD**: `amdgpu` (modern) and `radeonkms` (legacy)\n* **NVIDIA**: auto classifies to a supported branch (e.g., `nvidia-driver-580/470/390/340/304`)\n* **Generic**: `vesa`, `scfb` (syscons framebuffer)\n\n### Virtualization\n\n* **VirtualBox** (vboxguest/vboxservice enable \u0026 start)\n* **VMware**\n* **QEMU/KVM**\n* **Microsoft Hyper-V**\n* **Unknown Hypervisors**: `vesa` fallback\n\n---\n\n## Requirements\n\n* GhostBSD / FreeBSD with `pkg`\n* `bsddialog` (preferred) or `dialog`\n* X Window components present on the system\n* Root privileges (`sudo`)\n\n\u003e The script will also use `/xdrivers` (if available) for offline `.pkg` files, falling back to `pkg` repos otherwise.\n\n---\n\n## Installation\n\n### Quick Install\n\n```bash\n# Clone\ngit clone https://github.com/GhostBSD/xconfig.git\ncd xconfig\n\n# Install the script\nsudo install -m 755 bin/xconfig /usr/local/bin/xconfig\n\n# Install external config templates (system-wide)\nsudo mkdir -p /usr/local/etc/X11/cardDetect\nsudo cp -r cardDetect/* /usr/local/etc/X11/cardDetect/\n```\n\n\u003e The script also looks for `cardDetect` **next to the script** (`$SCRIPT_DIR/cardDetect`) so you can run in-tree during development.\n\n---\n\n## Usage\n\n### Automatic (recommended)\n\n```bash\nsudo xconfig auto\n```\n\nDetects hardware and applies the best configuration (including NVIDIA/AMD/Intel and hypervisors).\n\n### Interactive setup\n\n```bash\nsudo xconfig setup\n# or\nsudo xconfig manual\n```\n\nOpens the bsddialog/dialog UI. Choices are built safely via `set --` (no fragile quoting).\n\n### Direct targets\n\n```bash\n# GPUs\nsudo xconfig nvidia         # Auto-detect the correct NVIDIA branch\nsudo xconfig intel          # Intel with external config template\nsudo xconfig intel-auto     # Intel auto (no config file)\nsudo xconfig amd            # Auto decide: amdgpu or radeonkms (based on device)\nsudo xconfig amdgpu         # Force amdgpu template\nsudo xconfig radeonkms      # Force radeonkms template\n\n# Virtualization\nsudo xconfig virtualbox\nsudo xconfig vmware\nsudo xconfig qemu\nsudo xconfig hyperv\n\n# Fallback / recovery\nsudo xconfig vesa\nsudo xconfig scfb\nsudo xconfig safe\n\n# Advanced\nsudo xconfig dual           # Dual-monitor template\n```\n\n### System Info / Debug\n\n```bash\nsudo xconfig debug\n```\n\nPrints FreeBSD version, detected GPUs, candidate drivers, current Xorg status, presence of `/xdrivers`, and available config templates.\n\n---\n\n## External Configuration Files\n\nPlace templates in either:\n\n* `$(dirname \"$0\")/cardDetect/` (development/portable), or\n* `/usr/local/etc/X11/cardDetect/` (system-wide)\n\n| File                    | Purpose                  |\n| ----------------------- | ------------------------ |\n| `XF86Config.intel`      | Intel (i915kms, tuned)   |\n| `XF86Config.amdgpu`     | Modern AMD (Glamor/DRI3) |\n| `XF86Config.radeonkms`  | Legacy AMD (DRI2)        |\n| `XF86Config.virtualbox` | VirtualBox               |\n| `XF86Config.vmware`     | VMware                   |\n| `XF86Config.qemu`       | QEMU/KVM                 |\n| `XF86Config.hyperv`     | Microsoft Hyper-V        |\n| `XF86Config.scfb`       | Syscons framebuffer      |\n| `XF86Config.vesa`       | Generic VESA             |\n| `XF86Config.safe`       | Minimal recovery         |\n| `XF86Config.dual`       | Dual-monitor starter     |\n\n\u003e When a template is applied, the existing `/etc/X11/xorg.conf` is backed up to `/etc/X11/backup/xorg.conf.YYYYMMDD_HHMMSS`.\n\n---\n\n## NVIDIA Branch Selection (heuristic)\n\nThe script classifies the device and selects an appropriate package branch:\n\n* Newer/modern: `nvidia-driver-580`\n* Previous gens: `nvidia-driver-470`\n* Older gens: `nvidia-driver-390`, `nvidia-driver-340`, `nvidia-driver-304`\n\n\u003e Exact package names available on your system may vary; the script lists available `nvidia-driver-*` if installation fails.\n\n---\n\n## Offline Drivers (`/xdrivers`)\n\nIf `/xdrivers/drivers-list` and corresponding `.pkg` files exist, `xconfig` installs from there first:\n\n```\n/xdrivers/drivers-list      # lines: \"\u003cpkgname\u003e \u003cfilename.pkg\u003e\"\n/xdrivers/\u003cfilename.pkg\u003e    # package payloads\n```\n\nFalls back to `pkg install` on failure.\n\n---\n\n## License\n\nBSD 2-Clause “Simplified” License — see [LICENSE](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostbsd%2Fxconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghostbsd%2Fxconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostbsd%2Fxconfig/lists"}