Skip to content

Commit 1d64e9e

Browse files
feat(install): pre-built image instructions (#199)
1 parent 9e9562f commit 1d64e9e

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

install.rst

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,17 @@
33
============
44
Installation
55
============
6-
.. note::
76

8-
Please ensure that the :ref:`System requirements <system-requirements-section>` are met before installation.
7+
First, ensure that the :ref:`System requirements
8+
<system-requirements-section>` are met.
99

10-
Installation methods
11-
====================
12-
13-
You can install NethServer 8 :ref:`on a supported distribution <install_linux-section>` or use one of :ref:`pre-built images <install_image-section>`.
14-
Both methods require a working Internet connection.
10+
You can install NethServer 8 on a supported distribution or use a
11+
pre-built image. Both methods require an active Internet connection.
1512

1613
.. _install_linux-section:
1714

18-
Install on a supported distribution
19-
-----------------------------------
15+
Standard procedure
16+
==================
2017

2118
Pick your preferred Linux distribution between :ref:`supported ones
2219
<supported-distros-section>`.
@@ -32,28 +29,28 @@ If the ``curl`` command is not available try to install it with: ::
3229
.. _install_image-section:
3330

3431
Pre-built image
35-
---------------
32+
===============
3633

3734
.. |nbsp| unicode:: 0xA0
3835
:trim:
3936

40-
NethServer 8 provides an image built upon the stable foundation Rocky
41-
Linux 9, making it suitable for a wide range of server applications.
42-
43-
The pre-built image uses Cloud-init for network initialization. The
44-
default method to obtain network configuration is the DHCP protocol. Refer
45-
to your virtualization platform documentation for more information about
46-
Cloud-init support.
37+
The pre-built virtual machine image is based on Rocky Linux 9 and comes
38+
preconfigured with the packages and NS8 core components installed by the
39+
standard installation procedure. It uses Cloud-init for network
40+
initialization. Refer to your virtualization platform documentation for
41+
more information about Cloud-init support.
4742

4843
.. csv-table:: NS8 image download links
4944
:header: "Platform", "Format", "Size", "URL"
5045

51-
"QEMU/Proxmox", "qcow2", "1.7 |nbsp| GB", "https://tinyurl.com/ns8-rocky-qcow2"
52-
"VMWare", "vmdk", "3.0 |nbsp| GB", "https://tinyurl.com/ns8-rocky-vmdk"
46+
"Proxmox_ (QEMU)", "qcow2", "1.4 |nbsp| GB", "https://tinyurl.com/ns8-rocky-qcow2"
47+
"VMWare_ ESXi 8+", "vmdk", "2.8 |nbsp| GB", "https://tinyurl.com/ns8-rocky-vmdk"
48+
49+
.. _Proxmox: https://www.proxmox.com
50+
.. _VMWare: https://www.vmware.com
5351

54-
Choose the ``qcow2`` image format if you are using a KVM-based virtualization
55-
platform, like `Proxmox <https://www.proxmox.com/>`_, or the ``vmdk`` format
56-
if you are using something like `VMware <https://www.vmware.com>`_.
52+
If your platform is not in the above list the prebuilt image cannot be
53+
used. Please refer to :ref:`install_linux-section`.
5754

5855
When the image download has completed verify the file integrity with the
5956
`sha256 checksum file
@@ -64,26 +61,29 @@ checksum then run for example the following command: ::
6461

6562
Virtualization platform-specific notes:
6663

67-
- For VMWare, configure the virtual machine to use the IDE driver for the disk.
64+
- For VMWare ESXi 8+, add a hard disk with existing image and select *IDE
65+
controller 1 (Master)*.
66+
6867
- On Proxmox, for maximum performance, select ``host`` as the CPU type. Avoid "kvm64", because Rocky Linux image does not support it. Refer to `Proxmox documentation`_ for further details about CPU selection.
6968

7069
.. _Proxmox documentation: https://pve.proxmox.com/pve-docs/chapter-qm.html#qm_cpu
7170

72-
73-
Finally, start the NS8 image within your virtualization platform, or
74-
upload it to a cloud provider to create a public virtual machine.
71+
Finally, start the NS8 image within your virtualization platform. If
72+
Cloud-init does not find a network configuration, it attempts to obtain
73+
one via DHCP. After a few seconds, the system console displays a login
74+
prompt showing the assigned IP address.
7575

7676
Default OS administrative credentials are
7777

7878
* Username: ``root``
7979
* Password: ``Nethesis,1234``
8080

81-
Access the system console and log in using the default credentials. Upon
82-
the first login, you will be prompted to change the password.
81+
Log in using the default credentials. On the first login, you will be
82+
prompted to change the root password.
8383

84-
To obtain administrative SSH access to the system, create a personal user
85-
account in the ``wheel`` group and set a password. For instance, execute
86-
the following commands and enter the desired password: ::
84+
SSH access is disabled for root. To obtain administrative SSH access,
85+
create a personal user account in the ``wheel`` group and set a password.
86+
For example, run the following commands and enter the desired password: ::
8787

8888
useradd -G wheel ethan.smith
8989
passwd ethan.smith

0 commit comments

Comments
 (0)