summaryrefslogtreecommitdiff
path: root/docs/image-mgmt.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/image-mgmt.rst')
-rw-r--r--docs/image-mgmt.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/image-mgmt.rst b/docs/image-mgmt.rst
index 2c92f7b4..6c1b2587 100644
--- a/docs/image-mgmt.rst
+++ b/docs/image-mgmt.rst
@@ -108,12 +108,17 @@ for the new image to boot using the current configuration.
.. note:: Only LTS releases are PGP-signed.
-.. opcmd:: add system image <url | path>
+.. opcmd:: add system image <url | path> [vrf name] [username user [password pass]]
Use this command to install a new system image. You can reach the
image from the web (http://, https://) or from your local system,
e.g. /tmp/vyos-1.2.3-amd64.iso.
+ The `add system image` command also supports installing new versions
+ of VyOS through an optional given VRF. Also if URL in question requires
+ authentication, you can specify an optional username and password via
+ the commandline which will be passed as "Basic-Auth" to the server.
+
If there is not enough **free disk space available**, the installation
will be canceled. To delete images use the :opcmd:`delete system image`
command.
@@ -122,9 +127,10 @@ VyOS configuration is associated to each image, and **each image has a
unique copy of its configuration**. This is different than a traditional
network router where the configuration is shared across all images.
-.. note:: If you have any personal file, like some scripts you created,
- and you don't want them to be deleted during the upgrade, make sure
- those files are into the ``/configure`` directory.
+.. note:: If you have any personal files, like some scripts you created,
+ and you don't want them to be lost during the upgrade, make sure
+ those files are stored in ``/config`` as this directory is always copied
+ to newer installed images.
You can access files from a previous installation and copy them to your
current image if they were located in the ``/config`` directory. This