Add docs for backing up logos #181
Conversation
docs/backup_and_restore.rst
Outdated
| As of SecureDrop |version|, the backup will not include any custom logo file | ||
| that you may have configured for your SecureDrop instance. To back up the logo, | ||
| download it using Tor Browser or on the command line. From ``~/Persistent`` | ||
| (a level above the ``securedrop`` directory), the following command will |
There was a problem hiding this comment.
Suggested going to ~/Persistent because this file is not included in .gitignore, so it would otherwise mess up future git status output. (freedomofpress/securedrop#3502 can't come soon enough.)
eloquence
force-pushed
the
save-the-logos
branch
from
d24f58c
to
e081076
Compare
docs/backup_and_restore.rst
Outdated
| Backing up your custom logo | ||
| ''''''''''''''''''''''''''' | ||
|
|
||
| As of SecureDrop |version|, the backup will not include any custom logo file |
There was a problem hiding this comment.
This behaviour's been the same since the custom logo settings moved into the JI, by my casual read, so I think you can leave out the reference to the version (it might be misleading to folks who have an older backup and expect that it will get restored)
There was a problem hiding this comment.
Good point, removed in beef2f0, we'll just remove that language in its entirety once the issue is fixed.
docs/backup_and_restore.rst
Outdated
| As of SecureDrop |version|, the backup will not include any custom logo file | ||
| that you may have configured for your SecureDrop instance. To back up the logo, | ||
| download it using Tor Browser or on the command line. From ``~/Persistent`` | ||
| (a level above the ``securedrop`` directory), the following command will |
There was a problem hiding this comment.
It might be better to tell folks to open a terminal and explicitly include the command, ie:
Open a terminal via Applications > System Tools > Terminal and run the following commands:
cd ~/Persistent
wget ......
Also, if you want to remove the v2/v3 stuff, you could grab the canonical source address from the shortcut file! (just realized this!) with cat ~/Desktop/source.desktop | grep Exec | awk '{print $2}'
There was a problem hiding this comment.
Nice! Simplified a bit further and used in beef2f0
These docs can be removed once a fix for freedomofpress/securedrop#5868 is included in a production release.
eloquence
force-pushed
the
save-the-logos
branch
from
e081076
to
beef2f0
Compare
Status
Ready for review. Whitespace clean up is in a separate commit, beef2f0 has the substantive changes.
Description of Changes
Add instructions for backing up and restoring logos. These docs can be removed once a fix for freedomofpress/securedrop#5868 is included in a production release.
Testing
Note that I've tested the
wgetv3 command (not the v2 one) on a prod Admin Workstation.Checklist (Optional)
make docs-lint) passed locallymake docs-linkcheck) passedmake docs) docs at http://localhost:8000