Skip to content

Commit 8095435

Browse files
committed
Fixes and suggestions
1 parent 5eb7a05 commit 8095435

5 files changed

Lines changed: 25 additions & 15 deletions

File tree

67.8 KB
Loading
131 KB
Loading
14.9 KB
Loading
81.6 KB
Loading

docs/user_manual/introduction/qgis_configuration.rst

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,13 @@ displayed at the bottom of the frame.
109109

110110
**Project files**
111111

112+
.. _figure_project_files_settings:
113+
114+
.. figure:: img/project_files_settings.png
115+
:align: center
116+
117+
Project Files Settings
118+
112119
* :guilabel:`Open project on launch`
113120

114121
* 'Welcome Page' (default): can display the "News" feed, the project
@@ -155,10 +162,11 @@ displayed at the bottom of the frame.
155162

156163
**Project Trust**
157164

158-
These options control how QGIS handles execution of embedded Python code contained
159-
in project files. Embedded code includes macros, custom expression functions,
160-
Python-based actions and attribute form initialization code. QGIS allows you to
161-
manage trust on a per-project or per-folder basis.
165+
These options control how QGIS handles execution of scripts
166+
in project files. Embedded code includes :ref:`macros <project_macros>`, :ref:`custom expression functions <vector_expressions>`,
167+
:ref:`actions <actions_menu>` and :ref:`attribute form initialization code <form_custom_functions>`. QGIS allows you to
168+
manage trust on a per-project or per-folder basis. When a project or folder is trusted, this applies to **all embedded scripts**
169+
contained within. Trust cannot be granted to individual scripts.
162170

163171
.. _figure_project_trust_settings:
164172

@@ -167,30 +175,32 @@ manage trust on a per-project or per-folder basis.
167175

168176
Project Trust Settings
169177

170-
* :guilabel:`Behavior for untrusted project's embedded Python code`:
178+
* :guilabel:`Behavior for embedded scripts within projects of undetermined trust`:
171179
Use the dropdown menu to select how QGIS should respond when opening a project
172180
whose trust status has not yet been decided. Options include:
173181

174-
* :guilabel:`Never Execute`: block execution of all embedded Python code.
175-
* :guilabel:`Never Ask for Trust`: execute all embedded Python code automatically for trusted projects or folders,
176-
without prompting. Denied projects are still blocked.
177-
* :guilabel:`Ask for Trust`: QGIS will display a trust dialog listing all embedded code and
182+
* :guilabel:`Never Execute`: block execution of all embedded scripts.
183+
* :guilabel:`Never Ask for Trust`: no request for project trust is made;
184+
undetermined or already denied projects have their embedded scripts blocked.
185+
Only trusted projects or folders have their embedded scripts executed.
186+
* :guilabel:`Ask for Trust`: QGIS will display a trust dialog (see :numref:`figure_security_prompt`) listing all embedded scripts and
178187
prompt you to allow or deny execution.
179-
* :guilabel:`Always Execute (Not recommended)`: enable execution of all embedded Python code.
188+
* :guilabel:`Always Execute (Not recommended)`: enable execution of all embedded scripts;
189+
not recommended because it bypasses all safety checks and can run untrusted or malicious code without prompting.
180190

181-
* :guilabel:`Trusted projects and folders allowed Python code execution`:
191+
* :guilabel:`Trusted projects and folders allowing embedded script execution`:
182192
This list shows project files or folders that you have explicitly marked as
183193
trusted. Projects located in these paths are allowed to run their embedded
184-
Python code without prompting. Use the |symbologyAdd|:sup:`Add new trusted project` or
194+
scripts without prompting. Use the |symbologyAdd|:sup:`Add new trusted project` or
185195
|symbologyRemove|:sup:`Remove trusted project or folder` buttons to manage the list.
186196

187-
* :guilabel:`Denied projects and folders Python code execution`:
197+
* :guilabel:`Untrusted projects and folders denied embedded script execution`:
188198
Paths listed here are explicitly marked as untrusted. Projects stored in these
189-
locations will never run embedded Python code. Use the |symbologyAdd|:sup:`Add new project denial` or
199+
locations will never run embedded scripts. Use the |symbologyAdd|:sup:`Add new project denial` or
190200
|symbologyRemove|:sup:`Remove denied project or folder` buttons to
191201
maintain the list.
192202

193-
When opening a project containing embedded Python code and whose trust state is
203+
When opening a project containing embedded scripts and whose trust state is
194204
not yet known, QGIS will present a trust dialog. The dialog shows all embedded
195205
code blocks and allows you to preview them before deciding whether to trust the
196206
project.

0 commit comments

Comments
 (0)