Files
playit-agent/README.md
T
Patrick Lorio b7af6317cb 0.16.0 (#110)
* stage

* impl udp footer v2

* stage

* impl Serialize for UdpChannelDetails

* stage

* Count more error paths

* Add proxy protocol

* stage

* progres on tcp

* complete tcp, get working in dev

* Add proto version to agent register

* update deps

* Update proto version stuff

* Make AgentRegister encoding backwards compatible

* Set type num to AgentRegisterV1 for old proto

* Add support for legacy ping

* Bump version and disable ping monitor
2025-07-18 12:07:31 -07:00

47 lines
1.6 KiB
Markdown

# The playit program
Looking for version 0.9.x? See [this branch](https://github.com/playit-cloud/playit-agent/tree/v0.9).
* Latest Release: 0.16.X
* Offical Website: https://playit.gg
* Offical Downloads: https://playit.gg/download
* Releases: https://github.com/playit-cloud/playit-agent/releases
Installing on ubuntu or debian
```
curl -SsL https://playit-cloud.github.io/ppa/key.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/playit.gpg >/dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/playit.gpg] https://playit-cloud.github.io/ppa/data ./" | sudo tee /etc/apt/sources.list.d/playit-cloud.list
sudo apt update
sudo apt install playit
```
Getting a warning in apt about playit's repo? Run these commands
```
sudo apt-key del '16AC CC32 BD41 5DCC 6F00 D548 DA6C D75E C283 9680'
sudo rm /etc/apt/sources.list.d/playit-cloud.list
sudo apt update
curl -SsL https://playit-cloud.github.io/ppa/key.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/playit.gpg >/dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/playit.gpg] https://playit-cloud.github.io/ppa/data ./" | sudo tee /etc/apt/sources.list.d/playit-cloud.list
sudo apt update
```
**Note**
Please only use the playit program if you downloaded if from an offical source or are compiling and running from source.
## Building / Running Locally
Requires Rust: https://rustup.rs
Run using `cargo run --release`
## Docker
```
docker run --rm -it --net=host -e SECRET_KEY=<secret key> ghcr.io/playit-cloud/playit-agent:latest
```
> [!NOTE]
> Secret key can be generated [here](https://playit.gg/account/agents/new-docker).