QGIS Deployment Toolbelt - Documentation

Description: QGIS deployment toolbelt is a CLI (Command Line Interface) to perform redundant operations after a QGIS deployment.
Author and contributors: Julien Moura (Oslandia), Vincent Bré (Oslandia)
Version: 0.29.0
Source code: https://github.com/Guts/qgis-deployment-cli/
Last documentation build: 16 November 2023

---

What it is and the underlying philosophy

Development is développement est conçu selon les principes suivants :

• a tailor-made tool for QGIS ecosystem

• open source and community driven

• independant from the QGIS installation mode

• packaged as CLI and prebuilt stand-alone binary

• cross-platform but with a strong focus on Windows

• documented

• tested

• usable with a single action (one-click run)

• easily reusable

• easily maintenable

• compatible with automation mechanisms:

  • cron / scheduled tasks

  • Windows groups policies (so called GPO for Group Policies Object) and tooling around client management

• flexible enough to be adapted to an internal security policy (allowing to put a custom code certificate)

It’s not

• an installer for QGIS

• a packager helper

---

How to use

• Installation
• How does it works: concepts and global workflow
• How to use
• Describe and prepare your QGIS profiles
• Write your deployment scenario
• Jobs configuration
• Command-line interface usage
• Configuration

Development

• Code documentation
• Contributing Guidelines
• Develop on Ubuntu
• Develop on Windows
• Documentation
• Tests
• Packaging
• Release workflow
• CHANGELOG

Guides

• How to use behind a network proxy
• How to get a plugin ID
• How to schedule the deployment
• How to: Sign the executable

Miscellaneous

• Platform compatibility
• Credits
• Funding