mirror/86Box-docs
1
0
Fork 0
mirror of https://github.com/86Box/docs.git synced 2026-02-21 17:15:33 -07:00
Code Issues Packages Projects Releases Wiki Activity

Split detailed info on networking to its own page

Browse Source
This commit is contained in:
RichardG867
2020-07-30 00:51:28 -03:00
parent 8776e46109
commit 9b490fc613
4 changed files with 96 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
index.rst
View File

@@ -35,6 +35,7 @@ to retro computing and, of course, 86Box. We look forward to hearing from you!
usage/machinespecific
usage/diskimages
usage/ideterqua
usage/network
.. toctree::
:maxdepth: 1

6
settings/machine.rst
View File

@@ -38,8 +38,8 @@ Enable the dynamic recompiler, which provides faster but less accurate CPU emula
Time synchronization
--------------------
Time synchronization automatically copies your host system's date and time settings over to the guest machine's hardware real-time clock. Synchronization is performed every time the guest operating system reads the hardware clock to calibrate its own internal clock, which usually happens once on every boot.
Time synchronization automatically copies your host system's date and time settings over to the emulated machine's hardware real-time clock. Synchronization is performed every time the emulated machine's operating system reads the hardware clock to calibrate its own internal clock, which usually happens once on every boot.
* **Disabled:** do not perform time synchronization.
* **Enabled (local time):** synchronize the time in your host system's configured timezone. Use this option when running a guest operating system which stores local time in the hardware clock, such as DOS or Windows.
* **Enabled (UTC):** synchronize the time in Coordinated Universal Time (UTC). Use this option when running a guest operating system which stores UTC time in the hardware clock, such as Linux.
* **Enabled (local time):** synchronize the time in your host system's configured timezone. Use this option when emulating an operating system which stores local time in the hardware clock, such as DOS or Windows.
* **Enabled (UTC):** synchronize the time in Coordinated Universal Time (UTC). Use this option when emulating an operating system which stores UTC time in the hardware clock, such as Linux.

48
settings/network.rst
View File

@@ -1,32 +1,25 @@
Network
=======
The *Sound* page contains settings related to the emulated machine's network connectivity.
The *Network* page contains settings related to the emulated machine's network connectivity.
Network type
------------
Network connection type to emulate.
Network emulation mode to use. See :doc:`../usage/network` for more information on these.
* **None:** disable networking.
* **PCap:** connect directly to a host network adapter, similarly to the *Bridge* setting of other virtualizers. `Npcap <https://nmap.org/npcap/>`_ must be installed, and the host system must be connected to a **wired network**, as support for wireless network adapters is rare.
* **SLiRP:** create a virtual network, similarly to the *NAT* setting of other virtualizers.
* SLiRP will automatically provide the guest with an IP address through DHCP. If you are unable to use DHCP, use the following static IP settings:
* IP address: 10.0.2.15
* Subnet mask: 255.255.255.0
* Default gateway: 10.0.2.2
* DNS server: 10.0.2.3
* SLiRP does not allow the host machine to communicate directly with the guest machine. If you are running a server on the guest machine, see :ref:`port-forwarding`.
.. note:: PCap can still be used with wireless connections if you install and configure the *Microsoft Loopback Adapter*, then use Windows' *Internet Connection Sharing* feature to share the host's connection with the Loopback Adapter, and configure PCap to use that adapter.
* **PCap:** connects directly to a host network adapter. Similar to the **Bridge** mode on other virtualizers.
* **SLiRP:** creates a private network with a virtual router. Similar to the **NAT** mode on other virtualizers.
PCap device
-----------
Host network adapter to use for PCap mode. If you aren't seeing any adapters, make sure Npcap is installed correctly and a compatible network adapter is present.
Host network adapter to use for PCap mode. If no adapters appear on this list, make sure that:
* A WinPcap-compatible driver is installed;
* The installed driver is compatible with your version of Windows;
* At least one compatible (wired) network adapter is present.
Network adapter
---------------
@@ -34,26 +27,3 @@ Network adapter
Network card to emulate. Only cards supported by the machine's expansion buses will be listed.
The *Configure* button opens a new window with settings specific to the selected network card, such as the I/O port and IRQ for ISA cards.
.. _port-forwarding:
Advanced: SLiRP port forwarding
-------------------------------
Port forwarding allows other machines to connect to TCP or UDP servers running on the guest system through the host's IP address when using the SLiRP network type. Port forwarding can be enabled by manually editing the configuration file (``86box.cfg`` by default) to add a ``[SLiRP Port Forwarding]`` section.
Port forwards are numbered starting from zero. The following configuration directives are available under the ``[SLiRP Port Forwarding]`` section (assuming port forward number 0):
* ``0_udp``: If this directive is missing or set to 0, forward a TCP port. If set to 1, forward an UDP port.
* ``0_from``: Port number on the host.
* ``0_to``: Port number on the guest. If this directive is missing, use the same port number as the host.
.. rubric:: Example: forwarding host TCP port 8080 to guest port 80, and host UDP port 5555 to guest port 5555
.. code-block:: none
[SLiRP Port Forwarding]
0_from = 8080
0_to = 80
1_udp = 1
1_from = 5555

83
usage/network.rst Normal file
View File

@@ -0,0 +1,83 @@
Networking
==========
86Box supports two connection modes for the :doc:`emulated network cards <../settings/network>`. The specific details on these connection modes and network emulation as a whole are outlined on this page.
SLiRP
-----
SLiRP creates a private network with a virtual router, allowing the emulated machine to reach the host, its network and the Internet; on the other hand, the host and other devices on its network cannot reach the emulated machine, unless :ref:`port forwarding <usage/network:SLiRP port forwarding>` is configured. This is similar to the **NAT** mode on other virtualizers.
The virtual router provides automatic IP configuration to the emulated machine through DHCP. If that is not an option, use the following static IP settings:
* **IP address:** 10.0.2.15
* **Subnet mask:** 255.255.255.0
* **Default gateway:** 10.0.2.2
* **DNS server:** 10.0.2.3
The host can be reached through IP address 10.0.2.2, while other devices on the host's network can be reached through their normal IP addresses.
.. note:: SLiRP is only capable of routing TCP and UDP traffic. Other protocols such as IPX and NetBEUI can only be used with :ref:`usage/network:PCap` networking.
PCap
----
PCap connects directly to one of the host's network adapters. The emulated machine must be configured as if it were a real machine on your network. This is similar to the **Bridge** mode on other virtualizers.
This mode requires `Npcap <https://nmap.org/npcap/>`_ (or another WinPcap-compatible driver) to be installed on the host. Only **wired Ethernet network connections** are compatible; Wi-Fi and other connections will not work at all, as they do not allow PCap to listen for packets bound to the emulated machine.
Private PCap network
^^^^^^^^^^^^^^^^^^^^
If you have an incompatible network connection (such as Wi-Fi), or if you wish to connect the emulated machine to the host without also connecting it to your network, a private network can be created with PCap in one of two ways:
* Install and configure the *Microsoft KM-TEST Loopback Adapter* included with Windows.
* Guides on how to install this adapter are available online.
* The adapter alone only provides a direct connection to the host, with no DHCP server, therefore requiring manual IP configuration on both the host and the emulated machine.
* Windows' *Internet Connection Sharing* feature can be used to connect the emulated machine to the host's network and the Internet, with DHCP for automatic IP configuration, similarly to SLiRP but with the added benefit that the host can reach the emulated machine without port forwarding.
* If VMware is installed, use one of the VMnet adapters included with it.
* VMnet1 (host-only) connects to the host only.
* VMnet8 (NAT) connects to the host, its network and the Internet.
Advanced features
-----------------
The following advanced features can be accessed by directly editing the virtual machine configuration file, which is ``86box.cfg`` by default.
MAC address
^^^^^^^^^^^
The MAC address used by each emulated network card is stored in its respective configuration file section. Only the suffix (last three octets) of the MAC address is stored; the prefix (first three octets) will always be the card manufacturer's `OUI <https://en.wikipedia.org/wiki/Organizationally_unique_identifier>`_, such as 00:E0:4C for Realtek.
.. rubric:: Example: MAC address 00:E0:4C:35:F4:C2 for the Realtek RTL8029AS
.. code-block:: none
[Realtek RTL8029AS]
mac = 35:f4:c2
SLiRP port forwarding
^^^^^^^^^^^^^^^^^^^^^
Port forwarding allows the host and other devices on its network to access TCP and UDP servers running on the emulated machine. This feature is configured through the ``[SLiRP Port Forwarding]`` section of the configuration file.
Port forwards are numbered starting from zero. The following configuration directives are available under the ``[SLiRP Port Forwarding]`` section (assuming port forward number 0):
* ``0_udp``: If this directive is missing or set to 0, forward a TCP port. If set to 1, forward an UDP port.
* ``0_from``: Port number on the host.
* ``0_to``: Port number on the emulated machine. If this directive is missing, use the same port number as the host.
The host can access forwarded ports through 127.0.0.1 or its own IP address, while other devices on the network can access them through the host's IP address.
.. rubric:: Example: forward host TCP port 8080 to guest port 80, and host UDP port 5555 to guest port 5555
.. code-block:: none
[SLiRP Port Forwarding]
0_from = 8080
0_to = 80
1_udp = 1
1_from = 5555