Skip to content

Commit 906616a

Browse files
committed
clarify install by creating a new section
PR: https://forum.opnsense.org/index.php?topic=8902.0
1 parent fb9ef08 commit 906616a

File tree

2 files changed

+35
-23
lines changed

2 files changed

+35
-23
lines changed

source/manual/install.rst

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Depending on you hardware and use case different installation media are provided
7777
+--------+-----------------------------------------------------+
7878
|Type | | Description |
7979
+========+=====================================================+
80-
| cdrom | | ISO installer image with live system capabilities |
80+
| dvd | | ISO installer image with live system capabilities |
8181
| | | running in VGA-only mode |
8282
+--------+-----------------------------------------------------+
8383
| vga | | USB installer image with live system capabilities |
@@ -118,14 +118,14 @@ Media Filename Composition
118118
platform_1 [label = "i386-" ];
119119
platform_2 [label = "amd64-" ];
120120

121-
OS -> cdrom-;
121+
OS -> dvd-;
122122

123123
group {
124124
orientation = portrait
125125
label = "Type";
126126
fontsize = 20;
127127

128-
cdrom- -> nano- -> serial- -> vga-;
128+
dvd- -> nano- -> serial- -> vga-;
129129

130130
}
131131

@@ -147,7 +147,7 @@ Media Filename Composition
147147

148148
}
149149

150-
cdrom- -> platform_1 -> "iso.bz2";
150+
dvd- -> platform_1 -> "iso.bz2";
151151

152152
}
153153

@@ -159,9 +159,9 @@ Media Filename Composition
159159
More information on our release schedule is available from our package
160160
repository see `README <https://pkg.opnsense.org/releases/16.1/README>`__
161161

162-
------------------
163-
OpenSSL & LibreSSL
164-
------------------
162+
--------------------
163+
OpenSSL and LibreSSL
164+
--------------------
165165

166166
OPNsense images are provided based upon `OpenSSL <https://www.openssl.org>`__.
167167
The `LibreSSL <http://www.libressl.org>`__ flavor can be selected from within
@@ -256,25 +256,37 @@ was used previously on an existing installation, the system will boot up with a
256256
fully functional setup, but will not overwrite the previous installation. Use
257257
this feature for safely previewing upgrades.
258258

259-
If you have used a CD-ROM, VGA, Serial image without a config import you are by
260-
default able to (a) log into the root shell using the user "root" with password
261-
"opnsense", or (b) log into the installer using the user "installer" with
262-
password "opnsense". The GUI will listen on https://192.168.1.1/ for user "root"
263-
with password "opnsense". Using SSH, the "root" and "installer" users are
264-
available as well on IP 192.168.1.1. Note that these install medias are
265-
read-only, which means your current live configuration will be lost after reboot.
259+
If you have used a DVD, VGA, Serial image you are by default able to log into
260+
the root shell using the user "root" with password "opnsense" to operate the
261+
live environment.
262+
263+
The GUI will listen on https://192.168.1.1/ for user "root" with password
264+
"opnsense" by default unless a previous configuration was imported. Using SSH,
265+
the "root" and "installer" users are available as well on IP 192.168.1.1. Note
266+
that these install medias are read-only, which means your current live
267+
configuration will be lost after reboot.
268+
269+
Installer Usage
270+
---------------
271+
If you have used a DVD, VGA, Serial image you are by default able to start the
272+
installer using the user "installer" with password "opnsense". On a previously
273+
imported configuration the password will be the same as root's password.
274+
275+
Should the installer user not work for any reason, log in as user "root", select
276+
option 8 from the menu and type "opnsense-installer". The "opnsense-importer" can
277+
be run this way as well should you require to run the import again.
278+
279+
The installer can always be run to clone an existing system, even for Nano
280+
images. This can be useful for creating live backups for later recovery.
266281

267282
Nano Image
268283
----------
269284
If you have used a Nano image, your system is already up and running as it is
270285
designed as such. It is set to read-write attempting to minimise write cycles by
271-
mounting relevant partitions as memory file systems. If you should require an
272-
installer anyway, log in as user "root", select option 8 from the menu and type
273-
"opnsense-installer". The "opnsense-importer" can be run this way as well should
274-
you require to run the import again.
275-
286+
mounting relevant partitions as memory file systems and reporting features
287+
disabled by default.
276288

277-
Create a bootable USB flash drive with the downloaded and unpacked img
289+
Create a bootable USB flash drive with the downloaded and unpacked image
278290
file. Configure your system to boot from USB.
279291

280292
Installation Steps

source/manual/virtuals.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Virtual & Cloud based Installation
55
------------
66
Local/Server
77
------------
8-
Installing OPNsense on a virtual machine can be done by using the cdrom iso image.
8+
Installing OPNsense on a virtual machine can be done by using the DVD ISO image.
99
Full instructions are available in chapter :doc:`install` .
1010

1111
General tips
@@ -61,8 +61,8 @@ KVM, Bhyve, VirtualBox).
6161
------
6262
Hosted
6363
------
64-
For hosted installations where you can't install using the cdrom iso an alternative
65-
approach is available in the form of **opnsense-bootstrap**.
64+
For hosted installations where you can't install using the DVD ISO an alternative
65+
approach is available in the form of **opnsense-bootstrap**.
6666

6767
opnsense-bootstrap
6868
------------------

0 commit comments

Comments
 (0)