Skip to content

Commit

Permalink
Ingress version 1.0.0 (#123)
Browse files Browse the repository at this point in the history
This is the v1.0.0 release of the ingress service. This release stabilizes the API and adds support for the WHIP protocol

 ## Changelog

 ### Added
-  WHIP support (#97)
- Expose heath and availability on the WHIP HTTP server (#109)
- Add support for optimally bypassing transcoding when ingesting WHIP (#111)
- Set the source track information in the ingress state (#121)

 ### Fixed

- Validate IngressInfo and populate missing fields with defaults (#90)
- Fix deadlock in appsrc (#116)
- Update synchronizer and use Jitter Buffer (#118)
  • Loading branch information
biglittlebigben committed Jun 26, 2023
1 parent 2c186c5 commit fd9e10b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ ingress --config=config.yaml
#### Running with Docker

To run against a local LiveKit server, a Redis server must be running locally. The Ingress service must be instructed to connect to LiveKit server and Redis on the host. The host network is accessible from within the container on IP:
- 192.168.65.2 on MacOS and Windows
- host.docker.internal on MacOS and Windows
- 172.17.0.1 on linux

Create a file named `config.yaml` with the following content:
Expand All @@ -184,17 +184,21 @@ Create a file named `config.yaml` with the following content:
log_level: debug
api_key: <your-api-key>
api_secret: <your-api-secret>
ws_url: ws://192.168.65.2:7880 (or ws://172.17.0.1:7880 on linux)
ws_url: ws://host.docker.internal:7880 (or ws://172.17.0.1:7880 on linux)
redis:
address: 192.168.65.2:6379 (or 172.17.0.1:6379 on linux)
address: host.docker.internal:6379 (or 172.17.0.1:6379 on linux)
```

In order to be able to use establish WHIP sessions over UDP, the container must be run with host networking enabled.

Then to run the service:

```shell
docker run --rm \
-e INGRESS_CONFIG_BODY=`cat config.yaml` \
-e INGRESS_CONFIG_BODY="`cat config.yaml`" \
-p 1935:1935 \
-p 8080:8080 \
--network host \
livekit/ingress
```

Expand Down
2 changes: 1 addition & 1 deletion version/version.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package version

const Version = "0.9.0"
const Version = "1.0.0"

0 comments on commit fd9e10b

Please sign in to comment.