diff --git a/docs/installation-windows.md b/docs/installation-windows.md index c7c123215..c62536680 100644 --- a/docs/installation-windows.md +++ b/docs/installation-windows.md @@ -6,7 +6,7 @@ To install the collector on Windows, first [download the latest MSI](https://git After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the collector. -Alternatively, you can run the Powershell command below to install the MSI with no UI. +Alternatively, the Powershell command below may be run to install the MSI with no UI. ```pwsh msiexec /i "" /quiet ``` @@ -17,19 +17,19 @@ After installing, the `observiq-collector` service will be running and ready for Logs from the collector will appear in the Application event log. -By default, the config file for the collector can be found at `C:\Program Files\observiq-collector\config.yaml`. When changing the configuration, you must restart the collector in order for config changes to take effect. +By default, the config file for the collector can be found at `C:\Program Files\observiq-collector\config.yaml`. When changing the configuration,the collector service must be restarted in order for config changes to take effect. ## Restarting the Collector Restarting the collector may be done through the services dialog. To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. -![The run dialog](./screenshots/launch-services.png) +![The run dialog](./screenshots/windows/launch-services.png) Locate the `observiq-collector` service, right click the entry, and click "Restart" to restart the collector. -![The services dialog](./screenshots/stop-restart-service.png) +![The services dialog](./screenshots/windows/stop-restart-service.png) -Alternatively, you may run the Powershell command below. +Alternatively, the Powershell command below may be run to restart the collector service. ```pwsh Restart-Service -Name "observiq-collector" ``` @@ -39,13 +39,13 @@ Restart-Service -Name "observiq-collector" Stopping the collector may be done through the services dialog. To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. -![The run dialog](./screenshots/launch-services.png) +![The run dialog](./screenshots/windows/launch-services.png) Locate the `observiq-collector` service, right click the entry, and click "Stop" to stop the collector. -![The services dialog](./screenshots/stop-restart-service.png) +![The services dialog](./screenshots/windows/stop-restart-service.png) -Alternatively, you may run the Powershell command below. +Alternatively, the Powershell command below may be run to stop the collector service. ```pwsh Stop-Service -Name "observiq-collector" ``` @@ -55,13 +55,13 @@ Stop-Service -Name "observiq-collector" Starting the collector may be done through the services dialog. To access the services dialog, press Win + R, enter `services.msc` into the Run dialog, and press enter. -![The run dialog](./screenshots/launch-services.png) +![The run dialog](./screenshots/windows/launch-services.png) Locate the `observiq-collector` service, right click the entry, and click "Start" to start the collector. -![The services dialog](./screenshots/start-service.png) +![The services dialog](./screenshots/windows/start-service.png) -Alternatively, you may run the Powershell command below. +Alternatively, the Powershell command below may be run to start the collector service. ```pwsh Start-Service -Name "observiq-collector" ``` @@ -70,15 +70,15 @@ Start-Service -Name "observiq-collector" To uninstall the collector on Windows, navigate to the control panel, then to the "Uninstall a program" dialog. -![The control panel](./screenshots/control-panel-uninstall.png) +![The control panel](./screenshots/windows/control-panel-uninstall.png) Locate the `observiq-collector` entry, and select uninstall. -![The uninstall or change a program dialog](./screenshots/uninstall-collector.png) +![The uninstall or change a program dialog](./screenshots/windows/uninstall-collector.png) Follow the wizard to complete removal of the collector. -Alternatively, you can run the Powershell command below to uninstall the collector. +Alternatively, Powershell command below may be run to uninstall the collector. ```pwsh (Get-WmiObject -Class Win32_Product -Filter "Name = 'observiq-collector'").Uninstall() ``` diff --git a/docs/screenshots/start-service.png b/docs/screenshots/start-service.png deleted file mode 100644 index c058e1d83..000000000 Binary files a/docs/screenshots/start-service.png and /dev/null differ diff --git a/docs/screenshots/stop-restart-service.png b/docs/screenshots/stop-restart-service.png deleted file mode 100644 index f16fb100d..000000000 Binary files a/docs/screenshots/stop-restart-service.png and /dev/null differ diff --git a/docs/screenshots/control-panel-uninstall.png b/docs/screenshots/windows/control-panel-uninstall.png similarity index 100% rename from docs/screenshots/control-panel-uninstall.png rename to docs/screenshots/windows/control-panel-uninstall.png diff --git a/docs/screenshots/launch-services.png b/docs/screenshots/windows/launch-services.png similarity index 100% rename from docs/screenshots/launch-services.png rename to docs/screenshots/windows/launch-services.png diff --git a/docs/screenshots/windows/start-service.png b/docs/screenshots/windows/start-service.png new file mode 100644 index 000000000..f1782cc9a Binary files /dev/null and b/docs/screenshots/windows/start-service.png differ diff --git a/docs/screenshots/windows/stop-restart-service.png b/docs/screenshots/windows/stop-restart-service.png new file mode 100644 index 000000000..36171f3cd Binary files /dev/null and b/docs/screenshots/windows/stop-restart-service.png differ diff --git a/docs/screenshots/uninstall-collector.png b/docs/screenshots/windows/uninstall-collector.png similarity index 100% rename from docs/screenshots/uninstall-collector.png rename to docs/screenshots/windows/uninstall-collector.png