Files
PX4-Autopilot/docs/en/index.md
T
f5586139e4 feat(security): define security scope (#28571)
* docs(mavlink): present link encryption alongside message signing

The hardening guide told integrators that production deployments must
enable message signing, presenting it as the only way to secure a MAVLink
link. Encrypting the link below MAVLink, with an encrypted radio, a VPN or
IPsec, is at least as strong: it uses standard, reviewed cryptography, it
gives confidentiality as well as authentication, and it covers every
interface on the link rather than only MAVLink.

Present both options, and reword the passages that assumed signing was the
only one.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

* docs(security): develop security fixes in public pull requests

Record that fixes are developed as ordinary public pull requests, with no
private forks and no embargoed branches.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

* docs(security): add security scope document

Describe the boundary the code implements today: what PX4 protects, what it
assumes about the layers beneath it, what the shipped default does and does
not do, and two lists for what is always in scope and what is out. It
describes the boundary rather than pre-deciding reports. A finding that fits
neither list stays a judgement call that maintainers make on the report.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

* docs(security): list a security maintainer for report triage

Security report triage had no named owner, so an unacknowledged report had
nowhere to go except the release managers. Add a Security block to the
maintainers list, and point the follow-up path in SECURITY.md at it.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

* docs(mavlink): note that the first signing key is unauthenticated

The guide already says to provision over a trusted link, and the info box says
that changing or disabling a key requires a signed message. It does not say that
setting the first one cannot, since there is no key to sign with yet, so a reader
can come away believing provisioning itself is protected.

Say plainly that the window exists, what an attacker gets from it, and how to
recover.

Assisted-by: Claude:claude-opus-5[1m]
Signed-off-by: Julian Oes <julian@oes.ch>

* Apply batched suggestions from code review

Co-authored-by: Sheren N <sherenyn@ad.uni-paderborn.de>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Julian Oes <julian@oes.ch>

* feat(security): more review fixup

* fix(security): only 1.18 gets security bugfixes

* fix(security): link to SECURITY_SCOPE

* fix(securiy): small wording fixups

* docs(security): scope by attacker position, not bug class

The "Always in scope" list made any memory corruption, race or hang a
vulnerability regardless of who can reach it. That is not how reports
have been handled: sanitizer runs in SITL have found and fixed many
such bugs as ordinary PRs, and a peer on an unsecured link already has
a shell.

Replace it with one test: a finding is a vulnerability when it gives
capability to an attacker who has neither the operator's access nor
physical access. Keep the in-tree board configuration rule, point to
the sanitizer docs, and fix two typos.

Assisted-by: Claude:claude-opus-5[1m]
Signed-off-by: Julian Oes <julian@oes.ch>

* fix(docs): formatting

* fix(maintainers): add Ramon to security as well

* docs(security): draw the boundary as a mermaid diagram

GitHub renders mermaid natively, so the boundary diagram no longer has to
be maintained as hand-aligned ASCII. Label the two zones with the wording
of the sentences below it, so the picture and the prose say the same
thing.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

* fix(docs): review fixups

* docs(security): say how to isolate the offboard transports

A direct cable between flight controller and companion is not enough on
its own: the agent or router republishes into the DDS or Zenoh network
on the companion, so that network is inside the boundary too.

Keep the scope document to what is inside the boundary and put the
isolation advice next to the uXRCE-DDS and Zenoh setup instructions.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Julian Oes <julian@oes.ch>

---------

Signed-off-by: Julian Oes <julian@oes.ch>
Co-authored-by: Sheren N <sherenyn@ad.uni-paderborn.de>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-09-21 10:49:01 +12:00

7.3 KiB
Raw Blame History

<script setup> import { useData } from 'vitepress' const { site } = useData(); </script>

PX4 Autopilot User Guide

Releases Discuss Discord

PX4 is an open-source autopilot for drones and autonomous vehicles. It runs on multirotors, fixed-wing, VTOL, helicopters, rovers, and more. This guide covers everything from assembly and configuration to flight operations and development.

:::warning

This guide is for the development version of PX4 (main branch). Use the Version selector to find the current stable version.

Documented changes since the stable release are captured in the evolving release note. :::

Try PX4

No hardware needed. Run PX4 in simulation with a single command using Docker or a .deb package. Connect QGroundControl, MAVSDK, or ROS 2 and start flying immediately.

For Developers

Want to modify PX4 or build from source? Start with the Development Guide: set up your dev environment, build the code, and run SITL simulation.

Getting Started

Start with Basic Concepts for an overview of the flight stack, flight modes, safety features, and supported hardware.

Developer Kits

The fastest way to get flying hardware for PX4 development. Official PX4 Developer Kits ship with the latest stable PX4 pre-installed on current Pixhawk-standard hardware, need no build skills, and are certified by the PX4 team.

Build a Vehicle

Pick your frame type: Multicopter, Fixed-Wing, VTOL, Helicopter, or Rover. Each section covers complete vehicles, kits, and DIY builds. For assembly instructions see Assembling a Multicopter or the equivalent for your frame.

Configure and Tune

Once assembled, follow the configuration guide for your vehicle type (e.g. Multicopter Configuration). This covers sensor calibration, flight mode setup, and tuning.

Hardware

The Hardware Selection & Setup section covers flight controllers, sensors, telemetry, RC systems, and payloads. See Payloads for camera and delivery integrations.

Fly

Read Operations to understand safety features and failsafe behavior before your first flight. Then see Basic Flying (Multicopter) or the equivalent for your frame type.

Security

Securing a deployment is the integrator's responsibility — PX4 ships with every control interface unauthenticated, unsigned, and unencrypted! The Security section collects the hardening documentation, and links to the security policy for reporting a vulnerability.

Support

Get help on the discussion forums or Discord. See the Support page for diagnosing problems, reporting bugs, and joining the weekly dev call.

Contributing

See the Contributing section for code, documentation, and translation guidelines.

Translations

There are several translations of this guide. Use the language selector in the top navigation.

License

PX4 code is free to use and modify under the terms of the permissive BSD 3-clause license. This documentation is licensed under CC BY 4.0. For more information see: Licences.

Calendar & Events

The Dronecode Calendar shows important community events for platform users and developers. Select the links below to display the calendar in your timezone (and to add it to your own calendar):

:::tip The calendar default timezone is Central European Time (CET).

:::

Icons

The following icons used in this library are licensed separately (as shown below):

placeholder icon made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY.

camera-automatic-mode icon made by Magnific (formerly Freepik) from www.flaticon.com is licensed by CC 3.0 BY.

Governance

The PX4 Autopilot project is hosted by the Dronecode Foundation, a Linux Foundation Collaborative Project. Dronecode holds all PX4 trademarks and serves as the project's legal guardian, ensuring vendor-neutral stewardship. No single company owns the name or controls the roadmap. The source code is licensed under the BSD 3-Clause license, so you are free to use, modify, and distribute it in your own projects.

Dronecode Logo Linux Foundation Logo

 

Doc build time: {{ $buildTime }}