upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-05-28 04:02:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Vendor / Hardwarre - add quickstart update existing documentation.

Browse source
This commit is contained in:
Ad Schellevis 2022-08-25 15:34:52 +02:00
parent 91db550d36
commit bf2a9d3a3b
5 changed files with 115 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
source/hardware/images/quickstart_be.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 250 KiB

BIN
source/hardware/images/quickstart_community.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 234 KiB

88
source/hardware/quickstart.rst Normal file
View file

@ -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.

32
source/hardware/serial_connectivity.rst
View file

@ -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 </manual/how-tos/serial_access>`
.. 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:

7
source/vendor.rst
View file

@ -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