diff --git a/source/hardware/images/quickstart_be.png b/source/hardware/images/quickstart_be.png new file mode 100644 index 00000000..ca655363 Binary files /dev/null and b/source/hardware/images/quickstart_be.png differ diff --git a/source/hardware/images/quickstart_community.png b/source/hardware/images/quickstart_community.png new file mode 100644 index 00000000..0ce4f39f Binary files /dev/null and b/source/hardware/images/quickstart_community.png differ diff --git a/source/hardware/quickstart.rst b/source/hardware/quickstart.rst new file mode 100644 index 00000000..8448f181 --- /dev/null +++ b/source/hardware/quickstart.rst @@ -0,0 +1,88 @@ +==================================== +Quickstart / getting started +==================================== + +------------------------------------ +Intro +------------------------------------ + +After opening the box of your just delivered appliance, there should be a quickstart included. +Your OPNsense® appliance has been pre-installed with the OPNsense® Business Edition software + +This quickstart applies to all of the devices acquired from the OPNsense® Shop (https://shop.opnsense.com/), which includes +the following series: + + +========= ============ ============================= ================== +Serie Formfactor Range Network driver(s) +========= ============ ============================= ================== +DEC6XX Desktop Entry level igb +DEC7XX Desktop Midrange igb, ax +DEC8XX Desktop Enterprise igb, ax +DEC26XX Rack Entry level igb +DEC27XX Rack Midrange igb, ax +DEC38XX Rack Enterprise igb, ax +DEC40XX Rack Enterprise / Datacenter igb, ax, [ice] +========= ============ ============================= ================== + +------------------------------------ +Port assignments +------------------------------------ + +The Ethernet ports of the appliance are assigned as follows: + +Port **0** is assigned to LAN with IP address :code:`192.168.1.1` and has a DHCP Server running with IP range +from :code:`192.168.1.100` to :code:`192.168.1.199`. + +Port **1** is assigned to WAN and uses DHCP Client to obtain an IP-address. + +Additional ports available on the device are left unconfigured, you can assign them later using :menuselection:`Interfaces->Assignments`. + +.. Note:: + + Ports on the devices are all numbered, 0-**X** (e.g. 0,1,2) for all 1 gbps standard ethernet ports, + X0-X\ **X** for SFP+ ports (e.g. X0, X1), XXV0-XXV\ **X** for SFP28 ports (e.g. XXV0, XXV1). + The numbering corresponds with the driver numbering, e.g. port **0** is usually :code:`igb0`, see the product + range for drivers used in the different models + +------------------------------------ +Console connectivity +------------------------------------ + +The supplied USB-cable can be used to gain console access (settings are: 115200 8N1). +Console access is restricted with a login. Use the following credentials: + +* user : **root** +* password : **opnsense** + +------------------------------------ +Web interface +------------------------------------ + +To gain access to the web interface (default IP: :code:`192.168.1.1`) use the following credentials: + +* user : **root** +* password : **opnsense** + +------------------------------------ +Next steps +------------------------------------ + +After performing basic setup, activate your OPNsense Business Edition license token and then update your system or +change to community when not planning to use the supplied license. +(The firmware update module is located at :menuselection:`System>Firmware>Settings`) + +**Option 1**: use Business Edition license + +.. image:: ./images/quickstart_be.png + :width: 500px + +**Option 2**: use Community Edition + +.. image:: ./images/quickstart_community.png + :width: 500px + + +.. Note:: + + The OPNsense Business Edition license token is sent by email including instructions on how to activate. diff --git a/source/hardware/serial_connectivity.rst b/source/hardware/serial_connectivity.rst index f78e713f..4798d28f 100644 --- a/source/hardware/serial_connectivity.rst +++ b/source/hardware/serial_connectivity.rst @@ -6,18 +6,34 @@ Serial Console connectivity The following device families offer a mini-usb connection which can be used for serial communication: -* DEC600 series -* DEC2600 series -* DEC700 series -* DEC2700 series -* DEC800 series -* DEC3800 series -* DEC4000 series +========= ============ ============================= +Serie Formfactor Range +========= ============ ============================= +DEC6XX Desktop Entry level +DEC7XX Desktop Midrange +DEC8XX Desktop Enterprise +DEC26XX Rack Entry level +DEC27XX Rack Midrange +DEC38XX Rack Enterprise +DEC40XX Rack Enterprise / Datacenter +========= ============ ============================= Supplied with the firewall is a mini-usb to usb cable, use this to connect the to your PC (Windows, Linux, Mac) next start your terminal program (Putty, screen, etc). -The baudrate should be set to :code:`115200,8N1` +The baudrate should be set to :code:`115200,8N1`, more information about how to use the serial console is available in +our :doc:`serial access guide ` + +.. admonition:: Windows Tip + + On windows a COM port would be assigned after connecting the unit to usb, to find which one (COM1, COM2, .,) to + use, keep the windows key pressed and hit :code:`R` (Windows+R) and execute the following command :code:`devmgmt.msc` + to open the device manager. + + In the device manager all available ports are visible under the "Ports (COM & LPT)" section. + + + .. _legacy_uart: diff --git a/source/vendor.rst b/source/vendor.rst index a65812f7..f1330620 100644 --- a/source/vendor.rst +++ b/source/vendor.rst @@ -1,14 +1,13 @@ ==================================== -Vendor +Vendor / Hardware ==================================== --------------------- -Hardware --------------------- +This chapter contains topics around official OPNsense supplied equipment. .. toctree:: :maxdepth: 2 :titlesonly: + hardware/quickstart hardware/serial_connectivity hardware/bios