docs: clean up

!9
This commit is contained in:
2024-02-23 17:00:17 +09:30
parent 5ca5b98b38
commit c41be4541e
3 changed files with 9 additions and 12 deletions

View File

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

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.
- 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
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
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>" \
-v "./scan_agent.yaml:/etc/phpipam/scan_agent.yaml" \
-v "./scan_server.yaml:/etc/phpipam/scan_server.yaml" \
-e "ANSIBLE_LOG_PATH=/var/log/ansible.log" \
-p "5000:5000" \
--name scan-agent \

View File

@ -56,8 +56,3 @@ The Server componet has the following workflow:
- _if no results found, no further processing occurs_
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.