diff --git a/.gitignore b/.gitignore index fbc2221..e69de29 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +0,0 @@ -dist/* -sdl-home/logs/* -sdl-home/data/* -sdl-id.json diff --git a/README.md b/README.md index 0573989..37080f1 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ For more information, see the [Design](docs/DESIGN.md) document. ## Getting Started -## SDL Manager Installation +See also: [Installation](docs/INSTALL.md) ``` $ git clone https://github.com/jhaverlack/sdl.git @@ -26,24 +26,22 @@ $ cd sdl $ install-sdl.sh ``` -> sdl-mgr is installed to $HOME/.sdl/sdl-mgr +Point you browser to http://IP-ADDR:8081 -sdl-mgr will be: -- installed to $HOME/.sdl/sdl-mgr -- run as a non-root user (e.g., `sdl-mgr@USER`) -- sets up USER based systemd service +#### Firewall Rules -### System D Process -> sdl-mgr runs as a non-root user (e.g., `sdl-mgr@USER`) +> NOTE: Firewall rules are required to allow SDL Worker to connect to your SDL Manager. ``` -$ sudo systemctl start sdl-mgr@USER -$ sudo systemctl status sdl-mgr@USER +sudo ufw allow in proto tcp from to any port 8081 +sudo ufw allow in proto tcp from to any port 1883 +sudo ufw allow in proto tcp from to any port 9001 +sudo ufw allow in proto udp from to any port 10101 ``` ## 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 @@ -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. -> 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 -``` -