PX4-Autopilot/docs/en/index.md
Ramon Roche 9adda29da2
docs(sim): add Try PX4 quick-start and pre-built packages reference (#26957)
Adds documentation for the SITL containers and .deb packages introduced in #26495. The containers are now live on Docker Hub: [`px4io/px4-sitl:latest`](https://hub.docker.com/r/px4io/px4-sitl) and [`px4io/px4-sitl-gazebo:latest`](https://hub.docker.com/r/px4io/px4-sitl-gazebo).

The main addition is a [Try PX4 Simulation](https://docs.px4.io/main/en/dev_setup/try_px4) page that leads with a single `docker run` command and gets someone flying in under a minute. It lives in Getting Started, right after Recommended Hardware/Setup, so it's one of the first things new users see.

The existing `.deb` package reference has been moved from `packaging/px4_sitl_deb.md` to `simulation/px4_sitl.md` and expanded to cover both containers and `.deb` packages on one page. Sections are ordered by how people use them: what's available, install, configure, connect QGC/MAVSDK, connect ROS 2.

Other changes:
- README now has a "Try PX4" section with the docker one-liner above "Build from Source"
- Landing page (`index.md`) reworked to lead with "Try PX4" before "For Developers"
- Toolchain page (`dev_env.md`) gets a tip redirecting simulation-only users to pre-built packages
- `getting_started.md` and `SUMMARY.md` updated with links to the new pages
- Simulation index tip updated to mention containers alongside `.deb` packages

The SIH container image is published as `px4io/px4-sitl` (renamed from `px4io/px4-sitl-sih`) so the default lightweight option carries the simplest name. The Gazebo image remains `px4io/px4-sitl-gazebo`.

Also upgrades all GitHub Actions in the SITL workflow to Node.js 24 compatible versions (`actions/checkout@v6`, `actions/cache@v5`, `actions/upload-artifact@v7`, `actions/download-artifact@v8`, `docker/setup-buildx-action@v4`, `docker/build-push-action@v7`) to fix the Node.js 20 deprecation warning ahead of the June 2026 deadline.

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-04-09 08:51:22 -07:00

6.6 KiB
Raw Permalink Blame History

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.

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.

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 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 }}