update docs

shukriadams · May 30, 2021 · 22e65e5 · 22e65e5
1 parent affb997
commit 22e65e5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -15,15 +15,13 @@
 - Runs on low-spec hardware like the Raspberry Pi 3.
 - Built-in dashboard will run on almost any browser, ideal for a Raspberry Pi in kiosk mode. 
 
-*NOTE:*
-
-- Never expose *Are We Down?* to the public internet - use it behind a firewall/router at all times! 
+*NOTE:* *Are We Down?* has no built-in security, do not expose it to the public internet. It is perfectly safe running behind a trusted firewall/router, that is what it was intended for. 
 
 ## Install options
 
 - [Docker ](/docs/install-docker.md) - Linux x64 + ARM7 (Raspberry Pi 3 or better)
 
-- [Binaries](https://github.com/shukriadams/arewedown/releases) - Linux x64 only.
+- [Binaries](https://github.com/shukriadams/arewedown/releases) - Linux + Windows x64. These are still experimental, ARM builds currently not possible due to hardware.
 
 - [NodeJS source](/docs/install-nodejs.md) - any OS that supports NodeJS 12.x or better.
 
@@ -103,6 +101,7 @@ There are several built-in tests
 - TCP Port open
 - Docker container up
 - Jenkins job passing
+- System.d process status
 
 Check the [built-in tests guide](/docs/built-in-tests.md) for details on how to configure these.
 

diff --git a/docs/advanced-settings.md b/docs/advanced-settings.md
@@ -40,8 +40,8 @@ If you do not want to store sensitive information like passwords in the `setting
 
     anyProperty: "{{env.MY_SENSITIVE_INFO}}"
 
-If you defined an environment variable `MY_SENSITIVE_INFO=1234` then `anyProperty` will have the value `1234` in memory. If the environment variable is not found, the application will fail to start.
+If you defined an environment variable `MY_SENSITIVE_INFO=1234` then `anyProperty` will have the value `1234` in memory. If the environment variable is not found, *AreWeDown?* will fail to start.
 
 ## Logs
 
-*AreWeDown?* logs, a lot. It writes its own logs to the `/etc/arewedown/logs/<DATE>.log`, and then for each watcher in `/etc/arewedown/logs/<WATCHER>/logs/<DATE>.log`. Use `docker logs arewdown` to quickly see recent log entries.        
+*AreWeDown?* logs, a lot. It writes its own logs to the `/etc/arewedown/logs/<DATE>.log`, and then for each watcher in `/etc/arewedown/logs/<WATCHER>/logs/<DATE>.log`. If *AreWeDown?* fails to start or exits abruptly, a good place to start looking is its logs. If you're running in docker, use `docker logs arewdown`.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -13,7 +13,3 @@ PRs, suggestions and bug reports are very welcome. If you're interesting in cont
 - Generally any test that targets well-known network/OS features as well as ubiquitous apps is welcome. Feel free to suggest, or PR your own implimentation.
 - Tests should be as generic and reuseable as possible. For example, instead of writing a test for a specific port like "Is SSH Server running?" a generic port test is preferred. It's up to the user to know they want to test port 22 for SSH server, but this covers the most use cases with the least amount of code.
 - Tests should ideally not require runtime additions - NPM packages can be added, but these should be stable and reliable.
-
-## Windows
-
-Even though *AreWeDown?* is a NodeJS app and runs fine on Windows, tests are implimented POSIX-first, and after that Linux-first. As there is no standard/easy way to get the required command line apps on Windows, Windows support is not feasible at this point.