No description
  • Go 66.2%
  • JavaScript 11.9%
  • HTML 10.5%
  • Objective-C 4.2%
  • NSIS 1.8%
  • Other 5.4%
Find a file
Lea Anthony 9a363d7be5
feat(v3): add server mode for headless HTTP deployment (#4903)
* feat(v3): add server mode for headless HTTP deployment

Server mode allows Wails applications to run as pure HTTP servers
without native GUI dependencies. Enable with `-tags server` build tag.

Features:
- HTTP server with configurable host/port via ServerOptions
- WAILS_SERVER_HOST and WAILS_SERVER_PORT env var overrides
- WebSocket event broadcasting to connected browsers
- Browser clients represented as BrowserWindow (Window interface)
- Health check endpoint at /health
- Graceful shutdown with configurable timeout
- Docker support with Dockerfile.server template and tasks

Build and run:
  wails3 task build:server
  wails3 task run:server
  wails3 task build:docker
  wails3 task run:docker

Documentation at docs/guides/server-build.mdx

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(v3): add server mode for headless HTTP deployment

Server mode allows Wails applications to run as pure HTTP servers
without native GUI dependencies. Enable with `-tags server` build tag.

Features:
- HTTP server with configurable host/port via ServerOptions
- WAILS_SERVER_HOST and WAILS_SERVER_PORT env var overrides
- WebSocket event broadcasting to connected browsers
- Browser clients represented as BrowserWindow (Window interface)
- Health check endpoint at /health
- Graceful shutdown with configurable timeout
- Docker support with Dockerfile.server template and tasks

Build and run:
  wails3 task build:server
  wails3 task run:server
  wails3 task build:docker
  wails3 task run:docker

Documentation at docs/guides/server-build.mdx

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: address CodeRabbit review comments

- Fix corrupted test file with embedded terminal output
- Fix module name mismatch in gin-routing (was gin-example)
- Fix replace directive version mismatch in gin-service
- Fix placeholder module name in ios example (was changeme)
- Fix Dockerfile COPY path to work from both build contexts
- Fix bare URL in README (MD034 compliance)
- Fix comment accuracy in getScreens (returns error, not empty slice)
- Remove deprecated docker-compose version field
- Add port documentation in Taskfile template

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: address CodeRabbit review comments

- Add note about healthcheck wget not being available in distroless images
- Add !server build constraint to menu_windows.go and menu_darwin.go
- Downgrade window-visibility-test go.mod from 1.25 to 1.24 to match CI

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-25 14:33:44 +11:00
.github feat(macos): add CollectionBehavior option to MacWindow (#4799) 2025-12-29 11:07:37 +11:00
assets/images [ImgBot] Optimize images (#1812) 2022-09-12 21:57:07 +10:00
docs feat(v3): add server mode for headless HTTP deployment (#4903) 2026-01-25 14:33:44 +11:00
mkdocs-website/docs/en [V3] feat: add Windows getAccentColor implementation (#4427) 2025-07-25 21:46:05 +10:00
scripts Add issue management automation tools 2025-05-14 20:47:45 +10:00
v2 Dependency updates 2025-05-15 06:26:20 +10:00
v3 feat(v3): add server mode for headless HTTP deployment (#4903) 2026-01-25 14:33:44 +11:00
website docs: add Linux runtime dependencies and nfpm packaging guide (#4779) 2025-12-13 10:59:33 +11:00
.all-contributorsrc [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
.coderabbit.yaml Add code rabbit for alpha 2024-07-29 20:46:15 +10:00
.gitignore Merge Android support from v3-alpha-feature/android-support 2025-12-10 18:37:24 +11:00
.prettierignore chore: add Prettier as format tool (#2689) 2023-05-30 07:40:54 +10:00
.prettierrc.yml [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
AGENTS.md fix(v3): overhaul drag-and-drop for Linux reliability and simplify Windows implementation (#4848) 2026-01-04 11:08:29 +11:00
CHANGELOG.md chore: sort out files (#1776) 2022-08-22 20:02:27 +10:00
CNAME Add CNAME 2023-10-29 09:48:37 +11:00
CONTRIBUTING.md chore: sort out files (#1776) 2022-08-22 20:02:27 +10:00
CONTRIBUTORS.md Fix BackgroundColour documentation. Update changelog. Move contributors into website. Create changelog link. 2022-07-25 20:11:04 +10:00
IOS_ARCHITECTURE.md Merge iOS support from v3-alpha-feature/ios-support 2025-12-10 18:34:21 +11:00
LICENSE Update license and readme 2019-04-08 19:18:39 +10:00
qodana.yaml Add status table to docs. 2023-09-06 20:59:45 +10:00
README.de.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.es.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.fr.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ja.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ko.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.pt-br.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ru.md Update README.ru.md (#3544) 2024-06-17 18:40:22 +10:00
README.tr.md Added README.tr.md for supporting turkish language (#3528) 2024-06-08 09:51:35 +10:00
README.uz.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.zh-Hans.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
SECURITY.md Update SECURITY.md 2024-02-14 18:15:24 +11:00
Taskfile.yaml Docs change 2024-12-13 22:00:25 +11:00
test-changelog-extraction.sh Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00
test-ios-compile.sh Merge iOS support from v3-alpha-feature/ios-support 2025-12-10 18:34:21 +11:00
test-version-logic.sh Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00
test-workflow.md Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00


Build desktop applications using Go & Web Technologies.

GitHub Go Reference CodeFactor Awesome Discord
Build GitHub tag (latest SemVer pre-release)

Table of Contents

Introduction

The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative!

Features

  • Use standard Go for the backend
  • Use any frontend technology you are already familiar with to build your UI
  • Quickly create rich frontends for your Go programs using pre-built templates
  • Easily call Go methods from Javascript
  • Auto-generated Typescript definitions for your Go structs and methods
  • Native Dialogs & Menus
  • Native Dark / Light mode support
  • Supports modern translucency and "frosted window" effects
  • Unified eventing system between Go and Javascript
  • Powerful cli tool to quickly generate and build your projects
  • Multiplatform
  • Uses native rendering engines - no embedded browser!

Roadmap

The project roadmap may be found here. Please consult it before creating an enhancement request.

Getting Started

The installation instructions are on the official website.

Sponsors

This project is supported by these kind people / companies:

FAQ

  • Is this an alternative to Electron?

    Depends on your requirements. It's designed to make it easy for Go programmers to make lightweight desktop applications or add a frontend to their existing applications. Wails does offer native elements such as menus and dialogs, so it could be considered a lightweight electron alternative.

  • Who is this project aimed at?

    Go programmers who want to bundle an HTML/JS/CSS frontend with their applications, without resorting to creating a server and opening a browser to view it.

  • What's with the name?

    When I saw WebView, I thought "What I really want is tooling around building a WebView app, a bit like Rails is to Ruby". So initially it was a play on words (Webview on Rails). It just so happened to also be a homophone of the English name for the Country I am from. So it stuck.

Stargazers over time

Star History Chart

Contributors

The contributors list is getting too big for the readme! All the amazing people who have contributed to this project have their own page here.

License

FOSSA Status

Inspiration

This project was mainly coded to the following albums: