opnsense/docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2025-12-10 14:33:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

source/manual: Extend git-backup doc with Force Push (#784)

Browse Source
This commit is contained in:
Hleb Shauchenka 2025-10-19 13:34:07 +02:00 committed by GitHub
parent 8a67284d1c
commit ee7fc1b902
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/manual/git-backup.rst
View File

@ -83,6 +83,8 @@ SSH private key When using ssh, make sure to add a private
User Name Username, when using gitlab and ssh, the default is :code:`git` here
(most of these providers use a single user and identify the user by its key)
password When using https authentication, choose a password here.
Force Push Enable force push to overwrite the remote repository with the local state.
See "Conflict resolution" below for details.
==================================== ===============================================================================
Make sure to push to an empty (as in, new and never used) upstream repository, when pressing "Setup/Test Git" the initial
@ -144,6 +146,30 @@ The repository is available on the OPNsense machine in the following directory :
accept feature requests trying to push to existing (used) repositories.
Using Force Push
^^^^^^^^^^^^^^^^^
When the local and remote repositories diverge (for example after restoring a configuration via the GUI),
synchronization will fail with a **git out of sync** error. The Force Push option can be used to resolve
this by overwriting the remote with the local repository state.
.. Warning::
Force pushing permanently overwrites the remote repository history with your local state.
Any commits that exist remotely but not locally will be lost.
To resolve a divergence:
1. Navigate to :menuselection:`System --> Configuration --> Backups --> Git`
2. Enable the **Force Push** option
3. Click **Setup/Test Git** to push the current state
4. (Optional) Disable **Force Push** and click **Setup/Test Git** again to verify normal operation
The Force Push option can also be left enabled permanently to ensure the remote always mirrors the local state.
For manual conflict resolution, access the repository in :code:`/conf/backup/git` and use standard git commands.
--------------------------
Error handling
--------------------------