docs: initial docker pages

!1

docs/projects/ansible/collection/phpipam_scan_agent/docker.md

@@ -0,0 +1,36 @@
+---
+title: phpIPAM Scan Agent Docker Container
+description: No Fuss Computings {php}IPAM Scan Agent Docker Container
+date: 2024-02-21
+template: project.html
+about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
+---
+
+The Scan Agent Docker container has the Ansible collection installed which when launched will by default, start a Scan Server and scanner. The components running inside the container can be customised to suit different use cases.
+
+
+## Usage
+
+Launching the docker container can be done with
+
+``` bash
+
+docker run \
+    -d \
+    -e "API_URL=<your value here>" \
+    -e "MYSQL_HOST=<your value here>" \
+    -e "MYSQL_USER=<your value here>" \
+    -e "MYSQL_PASSWORD=<your value here>" \
+    -e "SCANNER_TOKEN=<your value here>" \
+    -e "SCANNER_NAME=<your value here>" \
+    -e "SCANNER_CODE=<your value here>" \
+    -p "5000:5000" \
+    --name scan-agent \
+    scan-agent:dev;
+
+```
+
+### Logs
+
+when viewing the container logs `docker logs <container name>`, what you will see is the Server component logs. This is by design. If however you are also running the scanner component, as is the default. To view those logs you will need to ensure that when launching the container that you specify environmental variable `ANSIBLE_LOG_PATH=/var/log/ansible.log`. This tells the scanner component to log to file at path `/var/log/ansible.log`.
+

docs/projects/ansible/collection/phpipam_scan_agent/index.md

@@ -49,3 +49,4 @@ Currenty this collection has the following features:
 - [**ToDo** Remote Network Scanning](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/1)
 
 - [**ToDo** Resolve DNS names](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/4)
+

mkdocs.yml

@@ -30,6 +30,8 @@ nav:
 
         - projects/ansible/collection/phpipam_scan_agent/index.md
 
+        - Docker Container: projects/ansible/collection/phpipam_scan_agent/docker.md
+
         - Scanner: projects/ansible/collection/phpipam_scan_agent/scanner.md
 
         - Server: projects/ansible/collection/phpipam_scan_agent/server.md