ansible-collections/phpipam_scan_agent
2
0
Fork 0
Code Issues 10 Pull Requests Actions Projects Releases 7 Wiki Activity

docs: clean up

Browse Source 
!9
This commit is contained in:
Jon Lockwood
2024-02-23 17:00:17 +09:30
parent 5ca5b98b38
commit c41be4541e
3 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/projects/ansible/collection/phpipam_scan_agent/docker.md
View File

@ -20,6 +20,8 @@ Launching the docker container can be done with
docker run \ docker run \
-d \ -d \
-p "5000:5000" \ -p "5000:5000" \
-v "./scan_agent.yaml:/etc/phpipam/scan_agent.yaml" \
-v "./scan_server.yaml:/etc/phpipam/scan_server.yaml" \
--name scan-agent \ --name scan-agent \
nofusscomputing/phpipam-scan-agent:latest; nofusscomputing/phpipam-scan-agent:latest;

14
docs/projects/ansible/collection/phpipam_scan_agent/index.md
View File

@ -68,6 +68,11 @@ When this setting is enabled, the scanner will scan the entire subnet that has b
the work in [Hosts check](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/3), will adjust this behaviour to only add hosts that dont exist. the work in [Hosts check](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/3), will adjust this behaviour to only add hosts that dont exist.
- Location `Subnet -> Discover new hosts [Last discovery time]`
This is displayed within the subnet interface next to the `Discover new hosts` field. Whenever a scan report is received by the server this filed is updated to reflect the last scan time.
## Development Notes ## Development Notes
Contributions to this project are welcome. Below you will find some useful commands for use during development. Contributions to this project are welcome. Below you will find some useful commands for use during development.
@ -80,13 +85,8 @@ docker build . --tag scan-agent:dev --build-arg COLLECTION_BRANCH=<your feature
# Launch your build container # Launch your build container
docker run \ docker run \
-d \ -d \
-e "API_URL=<your value here>" \ -v "./scan_agent.yaml:/etc/phpipam/scan_agent.yaml" \
-e "MYSQL_HOST=<your value here>" \ -v "./scan_server.yaml:/etc/phpipam/scan_server.yaml" \
-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>" \
-e "ANSIBLE_LOG_PATH=/var/log/ansible.log" \ -e "ANSIBLE_LOG_PATH=/var/log/ansible.log" \
-p "5000:5000" \ -p "5000:5000" \
--name scan-agent \ --name scan-agent \

5
docs/projects/ansible/collection/phpipam_scan_agent/server.md
View File

@ -56,8 +56,3 @@ The Server componet has the following workflow:
- _if no results found, no further processing occurs_ - _if no results found, no further processing occurs_
1. Update the phpIPAM MariaDB/MySQL database directly 1. Update the phpIPAM MariaDB/MySQL database directly
## phpIPAM Features
- **Last discovery time** This is displayed within the subnet interface next to the `Discover new hosts` fieled. Whenever a scan report is received by the server this filed is updated to reflect the last scan time.