Skip to content

Add network to README #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iu2frl wants to merge 2 commits into
base: master
Choose a base branch
from
+9 −0
Open

Add network to README #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d79f05
Add network ports and API documentation to README
Apr 15, 2026
9e84d19
cleaning duplicates
Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ Everything wfview does, wfweb does too — plus a built-in web interface:

---

## Network Ports and API

wfweb exposes its web interface and REST API on two ports:

- **8080 (HTTPS):** Main web interface for browsers (required for mic/audio streaming). Accept the self-signed certificate warning.
- **8081 (HTTP):** REST API for scripts, curl, microcontrollers, and home automation (no HTTPS required).

For full API documentation, see [REST_API.md](REST_API.md).

## Getting started

There are three ways to run wfweb. Pick the one that matches your setup:
Expand Down