From 35ade3c281d23cfeb777ee453ec74c17409c3fa9 Mon Sep 17 00:00:00 2001
From: Lukas Holecek <hluk@email.cz>
Date: Mon, 21 Dec 2020 10:18:57 +0100
Subject: [PATCH] Add "Security" documentation
---
docs/faq.rst | 8 +++++-
docs/index.rst | 1 +
docs/password-protection.rst | 2 ++
docs/security.rst | 54 ++++++++++++++++++++++++++++++++++++
4 files changed, 64 insertions(+), 1 deletion(-)
create mode 100644 docs/security.rst
diff --git a/docs/faq.rst b/docs/faq.rst
index 051e635cd..9f78f8032 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -80,7 +80,7 @@ To re-enable the functionality select "File - Enable Clipboard Storing" (same sh
To permanently disable storing the clipboard in CopyQ:
-1. And pen "Preferences" (``Ctrl+P`` shortcut).
+1. Open "Preferences" (``Ctrl+P`` shortcut).
2. Go to "History" tab.
3. Clear "Tab for storing clipboard" field.
@@ -97,6 +97,8 @@ then choose what to import back.
Importing tabs and commands won't override existing tabs, and will create new ones.
+.. _faq-disable-notifications:
+
How to enable or disable displaying notification when clipboard changes?
------------------------------------------------------------------------
@@ -139,6 +141,8 @@ opens main window on Ctrl+Shift+1). To use the command in CopyQ:
To share your commands, you can select the commands from command list in
"Command" dialog and press "Copy Selected" button (or just hit Ctrl+C).
+.. _faq-ignore-password-manager:
+
How to omit storing text copied from specific windows like a password manager?
------------------------------------------------------------------------------
@@ -345,6 +349,8 @@ Here is the correct command to use for some editors::
code --wait %1
open -t -W -n %1
+.. _faq-config-path:
+
Where to find saved items and configuration?
--------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index ee9e608b1..eeb429194 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,6 +18,7 @@ advanced topics like scripting and application development process.
keyboard
images
tags
+ security
theme
faq
known-issues
diff --git a/docs/password-protection.rst b/docs/password-protection.rst
index c333db2ce..76e26c942 100644
--- a/docs/password-protection.rst
+++ b/docs/password-protection.rst
@@ -1,3 +1,5 @@
+.. _encrypt:
+
Password Protection
===================
diff --git a/docs/security.rst b/docs/security.rst
new file mode 100644
index 000000000..1b10c5d01
--- /dev/null
+++ b/docs/security.rst
@@ -0,0 +1,54 @@
+Security
+========
+
+This page describes how CopyQ handles the clipboard data and how to make the
+clipboard safer.
+
+Data Storage
+============
+
+By default, Any text or image in the clipboard is stored automatically in CopyQ.
+
+You can completely disable automatic clipboard storing or avoid storing content
+copied from windows with matching window titles.
+
+.. seealso::
+
+ - :ref:`faq-disable-clipboard-storing`
+ - :ref:`faq-ignore-password-manager`
+
+The data from all tabs are stored in the configuration directory unencrypted
+(unless the Encryption plugin is enabled for a tab).
+
+.. seealso::
+
+ - :ref:`faq-config-path`
+ - :ref:`encrypt`
+
+CopyQ does not collect any other data and does not send anything over network.
+
+Clipboard Content Visibility
+============================
+
+The clipboard content is normally shown in the item list of a clipboard tab,
+main window title, tray tool tip and notification.
+
+To disable showing the current clipboard in GUI, use `"No Clipboard
+in Title and Tool Tip" command
+<https://github.com/hluk/copyq-commands/tree/master/Scripts#no-clipboard-in-title-and-tool-tip>`__
+and disable notifications (in Preferences).
+
+.. seealso::
+
+ - :ref:`faq-disable-notifications`
+ - :ref:`faq-share-commands`
+
+Clipboard Access
+================
+
+Usually other applications can access clipboard content without any
+restriction.
+
+To restrict accessing the data after a long time, use `"Clear Clipboard After
+Interval" command
+<https://github.com/hluk/copyq-commands/tree/master/Scripts#clear-clipboard-after-interval>`__.
--
GitLab