HaverLab
/
sdl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README Cleanup

This commit is contained in:
John Haverlack 2026-01-31 14:01:47 -09:00
parent f815124b72
commit 16ac9a657e
2 changed files with 9 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -1,4 +0,0 @@
dist/*
sdl-home/logs/*
sdl-home/data/*
sdl-id.json

36
README.md
View File

@ -18,7 +18,7 @@ For more information, see the [Design](docs/DESIGN.md) document.
## Getting Started ## Getting Started
## SDL Manager Installation See also: [Installation](docs/INSTALL.md)
``` ```
$ git clone https://github.com/jhaverlack/sdl.git $ git clone https://github.com/jhaverlack/sdl.git
@ -26,24 +26,22 @@ $ cd sdl
$ install-sdl.sh $ install-sdl.sh
``` ```
> sdl-mgr is installed to $HOME/.sdl/sdl-mgr Point you browser to http://IP-ADDR:8081
sdl-mgr will be: #### Firewall Rules
- installed to $HOME/.sdl/sdl-mgr
- run as a non-root user (e.g., `sdl-mgr@USER`)
- sets up USER based systemd service
### System D Process > NOTE: Firewall rules are required to allow SDL Worker to connect to your SDL Manager.
> sdl-mgr runs as a non-root user (e.g., `sdl-mgr@USER`)
``` ```
$ sudo systemctl start sdl-mgr@USER sudo ufw allow in proto tcp from <NETWORK CIDR> to any port 8081
$ sudo systemctl status sdl-mgr@USER sudo ufw allow in proto tcp from <NETWORK CIDR> to any port 1883
sudo ufw allow in proto tcp from <NETWORK CIDR> to any port 9001
sudo ufw allow in proto udp from <NETWORK CIDR> to any port 10101
``` ```
## SDL Worker Installation ## SDL Worker Installation
Listen to UDP 10101 for beacon messages from SDL Manager. Listen to UDP 10101 for beacon messages broadcast by your SDL Manager.
``` ```
nc -u 127.0.0.1 10101 nc -u 127.0.0.1 10101
@ -53,19 +51,3 @@ nc -u 127.0.0.1 10101
Run the **curl** or **wget** command provided by SDL Manager UDP beacon to install SDL Worker locally. Run the **curl** or **wget** command provided by SDL Manager UDP beacon to install SDL Worker locally.
> sdl-wkr is installed to $HOME/.sdl/sdl-wkr
sdl-wrk will be:
- installed to $HOME/.sdl/sdl-wkr
- run as a non-root user (e.g., `sdl-wkr@USER`)
- sets up USER based systemd service
- get's configuration from the sdl-mgr UDP beacon
### System D Process
> sdl-mgr runs as a non-root user (e.g., `sdl-mgr@USER`)
```
$ sudo systemctl start sdl-wkr@USER
$ sudo systemctl status sdl-wkr@USER
```