oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#3110: More example config file and domain name changes

Browse Source
This commit is contained in:
Nick Todd
2025-03-12 15:47:26 +00:00
parent c54007daec
commit ea7898ce33
2 changed files with 23 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/source/simulation_components/system/applications/web_browser.rst
View File

@@ -66,7 +66,7 @@ The :ref:`DNSClient` must be configured to use the :ref:`DNSServer`. The :ref:`D
web_browser.run() web_browser.run()
# configure the WebBrowser # configure the WebBrowser
web_browser.target_url = "arcd.com" web_browser.target_url = "example.com"
# once DNS server is configured with the correct domain mapping # once DNS server is configured with the correct domain mapping
# this should work # this should work
@@ -80,15 +80,13 @@ Via Configuration
simulation: simulation:
network: network:
nodes: nodes:
- ref: example_computer - hostname: example_computer
hostname: example_computer type: computer
type: computer ...
... applications:
applications: - type: web-browser
- ref: web_browser options:
type: web-browser target_url: http://example.com/
options:
target_url: http://arcd.com/
Configuration Configuration
============= =============
@@ -101,11 +99,10 @@ The URL that the ``WebBrowser`` will request when ``get_webpage`` is called with
The URL can be in any format so long as the domain is within it e.g. The URL can be in any format so long as the domain is within it e.g.
The domain ``arcd.com`` can be matched by The domain ``example.com`` can be matched by
- http://arcd.com/ - http://example.com/
- http://arcd.com/users/ - example.com
- arcd.com
``Common Attributes`` ``Common Attributes``

26
docs/source/simulation_components/system/services/dns_server.rst
View File

@@ -20,7 +20,7 @@ Key capabilities
Usage Usage
===== =====
- Install on a Node via the ``SoftwareManager`` to start the database service. - Install on a Node via the ``SoftwareManager`` to start the database service.
- Service runs on TCP port 53 by default. (TODO: TCP for now, should be UDP in future) - Service runs on TCP port 53 by default.
Implementation Implementation
============== ==============
@@ -58,7 +58,7 @@ Python
dns_server.start() dns_server.start()
# configure DatabaseService # configure DatabaseService
dns_server.dns_register("arcd.com", IPv4Address("192.168.10.10")) dns_server.dns_register("example.com", IPv4Address("192.168.10.10"))
Via Configuration Via Configuration
@@ -69,17 +69,15 @@ Via Configuration
simulation: simulation:
network: network:
nodes: nodes:
- ref: example_server - hostname: example_server
hostname: example_server type: server
type: server ...
... services:
services: - type: dns-server
- ref: dns_server options:
type: dns-server domain_mapping:
options: example.com: 192.168.0.10
domain_mapping: another-example.com: 192.168.10.10
arcd.com: 192.168.0.10
another-example.com: 192.168.10.10
Configuration Configuration
============= =============
@@ -90,7 +88,7 @@ Configuration
Domain mapping takes the domain and IP Addresses as a key-value pairs i.e. Domain mapping takes the domain and IP Addresses as a key-value pairs i.e.
If the domain is "arcd.com" and the IP Address attributed to the domain is 192.168.0.10, then the value should be ``arcd.com: 192.168.0.10`` If the domain is "example.com" and the IP Address attributed to the domain is 192.168.0.10, then the value should be ``example.com: 192.168.0.10``
The key must be a string and the IP Address must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. The key must be a string and the IP Address must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.