summaryrefslogtreecommitdiff
path: root/docs/cli.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2024-05-28 12:24:30 +0200
committerrebortg <github@ghlr.de>2024-05-28 12:24:30 +0200
commit96039bd2f44018ae767930e252305bedece57156 (patch)
tree650373a9398085999f8bbb45b09b4896ca489f5f /docs/cli.rst
parent0a3febc9524e7f5d3df856bd9cf58aafb3500252 (diff)
parent2be191247b2f10f1bc3ae38f8bcb565ce0af0635 (diff)
downloadvyos-documentation-96039bd2f44018ae767930e252305bedece57156.tar.gz
vyos-documentation-96039bd2f44018ae767930e252305bedece57156.zip
Merge branch 'current' of github.com:vyos/vyos-documentation into current
Diffstat (limited to 'docs/cli.rst')
-rw-r--r--docs/cli.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 41b4b9e0..c1a9d14c 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -501,6 +501,9 @@ different levels in the hierarchy.
Warning: configuration changes have not been saved.
vyos@vyos:~$
+.. hint:: You can specify a commit message with
+ :cfgcmd:`commit comment <message>`.
+
.. _save:
.. cfgcmd:: save
@@ -854,7 +857,7 @@ to :cfgcmd:`commit`. You will have to set the commit-archive location.
TFTP, FTP, SCP and SFTP servers are supported. Every time a
:cfgcmd:`commit` is successful the ``config.boot`` file will be copied
to the defined destination(s). The filename used on the remote host will
-be ``config.boot-hostname.YYYYMMDD_HHMMSS``.
+be ``config.boot-hostname.YYYYMMDD_HHMMSS``.
.. cfgcmd:: set system config-management commit-archive location <URI>
@@ -869,8 +872,14 @@ be ``config.boot-hostname.YYYYMMDD_HHMMSS``.
* ``tftp://<host>/<dir>``
* ``git+https://<user>:<passwd>@<host>/<path>``
+ Since username and password are part of the URI, they need to be
+ properly url encoded if containing special characters.
+
.. note:: The number of revisions don't affect the commit-archive.
+ .. note:: When using Git as destination for the commit archive the
+ ``source-address`` CLI option has no effect.
+
.. note:: You may find VyOS not allowing the secure connection because
it cannot verify the legitimacy of the remote server. You can use
the workaround below to quickly add the remote host's SSH