From d59fa6713f3f78d5e98b9140adc81a036dcbf60a Mon Sep 17 00:00:00 2001 From: ru Date: Sun, 8 Oct 2023 10:33:17 +0200 Subject: [PATCH 1/3] 501 Create new article with instructions to manually remove update flag --- .../admin/maintenance/update_workstations.rst | 49 +++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 50 insertions(+) create mode 100644 docs/admin/maintenance/update_workstations.rst diff --git a/docs/admin/maintenance/update_workstations.rst b/docs/admin/maintenance/update_workstations.rst new file mode 100644 index 000000000..8a94d1c07 --- /dev/null +++ b/docs/admin/maintenance/update_workstations.rst @@ -0,0 +1,49 @@ +Troubleshooting Workstation Updates +=================================== + +This section includes some general troubleshooting instructions for common workstation +update issues. For additional, version-specific issues and recommended actions, +please see the relevant admin upgrade guide. + +Performing a manual update +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Sometimes, when an update doesn't go according to plan, it's necessary to perform a +manual update and clear the update flag. + +If the graphical updater fails and you want to perform a manual update instead, +first delete the graphical updater's temporary flag file, if it exists (the +``.`` before ``securedrop`` is not a typo): :: + + rm ~/Persistent/.securedrop/securedrop_update.flag + +This will prevent the graphical updater from attempting to re-apply the failed +update and has no bearing on future updates. You can now perform a manual +update by running the following commands: :: + + cd ~/Persistent/securedrop + git fetch --tags + gpg --keyserver hkps://keys.openpgp.org --recv-key \ + "2359 E653 8C06 13E6 5295 5E6C 188E DD3B 7B22 E6A3" + git tag -v + +The output should include the following two lines: :: + + gpg: using RSA key 2359E6538C0613E652955E6C188EDD3B7B22E6A3 + gpg: Good signature from "SecureDrop Release Signing Key " [unknown] + + +Please verify that each character of the fingerprint above matches what is +on the screen of your workstation. A warning that the key is not certified +is normal and expected. If the output includes the lines above, you can check +out the new release: :: + + git checkout + +.. important:: If you do see the warning "refname '' is ambiguous" in the + output, we recommend that you contact us immediately at securedrop@freedom.press + (`GPG encrypted `__). + +Finally, run the following commands: :: + + ./securedrop-admin setup + ./securedrop-admin tailsconfig \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index b0c17b5df..704eefdf6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -137,6 +137,7 @@ Get Started admin/maintenance/ossec_alerts admin/maintenance/backup_and_restore admin/maintenance/backup_workstations + admin/maintenance/update_workstations admin/maintenance/update_tails_usbs admin/maintenance/kernel_troubleshooting admin/maintenance/rebuild_admin From 1c506e89a9aa642a9ebe57db6980c74e63d6583e Mon Sep 17 00:00:00 2001 From: rudi kraeher Date: Wed, 18 Oct 2023 10:37:49 +0200 Subject: [PATCH 2/3] CR:use current version number instead of placeholder text --- docs/admin/maintenance/update_workstations.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/admin/maintenance/update_workstations.rst b/docs/admin/maintenance/update_workstations.rst index 8a94d1c07..6f92eb83b 100644 --- a/docs/admin/maintenance/update_workstations.rst +++ b/docs/admin/maintenance/update_workstations.rst @@ -24,7 +24,7 @@ update by running the following commands: :: git fetch --tags gpg --keyserver hkps://keys.openpgp.org --recv-key \ "2359 E653 8C06 13E6 5295 5E6C 188E DD3B 7B22 E6A3" - git tag -v + git tag -v 2.6.1 The output should include the following two lines: :: @@ -37,9 +37,9 @@ on the screen of your workstation. A warning that the key is not certified is normal and expected. If the output includes the lines above, you can check out the new release: :: - git checkout + git checkout 2.6.1 -.. important:: If you do see the warning "refname '' is ambiguous" in the +.. important:: If you do see the warning "refname '2.6.1' is ambiguous" in the output, we recommend that you contact us immediately at securedrop@freedom.press (`GPG encrypted `__). From ebc20f5f7a9bcfac83ab68abdf41de9e0d0e7a2b Mon Sep 17 00:00:00 2001 From: rudi kraeher Date: Wed, 18 Oct 2023 10:42:11 +0200 Subject: [PATCH 3/3] CR:add new article file to the version update script --- update_version.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/update_version.sh b/update_version.sh index dea95c782..4a35911cb 100755 --- a/update_version.sh +++ b/update_version.sh @@ -13,6 +13,7 @@ readonly OLD_VERSION=$(grep -oP '(?<=^version \= ")\d+\.\d+\.\d+' docs/conf.py) sed -i "s@$(echo "${OLD_VERSION}" | sed 's/\./\\./g')@$NEW_VERSION@g" docs/admin/installation/set_up_admin_tails.rst sed -i "s@$(echo "${OLD_VERSION}" | sed 's/\./\\./g')@$NEW_VERSION@g" docs/admin/maintenance/backup_and_restore.rst +sed -i "s@$(echo "${OLD_VERSION}" | sed 's/\./\\./g')@$NEW_VERSION@g" docs/admin/maintenance/update_workstations.rst sed -i "s@$(echo "${OLD_VERSION}" | sed 's/\./\\./g')@$NEW_VERSION@g" docs/conf.py sed -i "s@$(echo "${OLD_VERSION}" | sed 's/\./\\./g')@$NEW_VERSION@g" pyproject.toml