Apache NuttX is a mature, real-time embedded operating system (RTOS) https://nuttx.apache.org/
Find a file
Abhishek Mishra ba6a4d55fe !Documentation: describe build-time passwd generation workflow.
Document the new mkpasswd-based password generation system and its
integration with the build process.

Changes:
* Add comprehensive mkpasswd tool documentation to components/tools
* Update SIM board docs to explain generated passwd workflow
* Update ESP32-C3-legacy board docs for passwd generation
* Update RX65N board docs with credential handling guidance
* Document how to configure and use BOARD_ETC_ROMFS_PASSWD_* options
* Explain security benefits of build-time generation vs static files
* Update all doc examples from default username "admin" to "root"

BREAKING CHANGE: Boards using static /etc/passwd files in ETC_ROMFS
must migrate to the new build-time generation workflow documented in
Documentation/components/tools/index.rst. The old static passwd files
are no longer present in migrated boards; boards that relied on them
will fail to build until credentials are configured via Kconfig.

Signed-off-by: Abhishek Mishra <mishra.abhishek2808@gmail.com>
2026-04-14 16:06:30 +08:00
.github workflows/build.yml: job MSVC fix Filename too long 2026-04-13 23:55:10 +08:00
arch arch/xtensa/esp32: Fix ROM strdup heap issue in USER_HEAP mode 2026-04-14 09:21:17 +02:00
audio include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
binfmt include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
boards !boards: migrate SIM and ESP32-C3-legacy to generated passwd files. 2026-04-14 16:06:30 +08:00
cmake !build: add build-time password generation with mkpasswd tool. 2026-04-14 16:06:30 +08:00
crypto include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
Documentation !Documentation: describe build-time passwd generation workflow. 2026-04-14 16:06:30 +08:00
drivers video/gc0308: implement V4L2 horizontal flip control 2026-04-10 10:47:07 +02:00
dummy build: add initial cmake build system 2023-07-08 13:50:48 +08:00
fs fs/fat: fix incorrect representation of SFN files created on Linux 2026-04-14 09:51:20 +08:00
graphics include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
include nuttx/nx: compilation error occurs 2026-04-14 13:35:26 +08:00
libs include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
mm include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
net net/route: fix return value of net_writeroute_ipv6 2026-04-13 08:46:57 -03:00
openamp openamp: Fix Make style 2026-03-23 18:16:46 -04:00
pass1 Makefile: Remove make depend files by make distclean 2026-02-16 16:27:57 +01:00
sched include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
syscall Makefile: Remove make depend files by make distclean 2026-02-16 16:27:57 +01:00
tools !build: add build-time password generation with mkpasswd tool. 2026-04-14 16:06:30 +08:00
video include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
wireless include/debug.h: Move to include/nuttx/debug.h 2026-04-07 07:50:06 -03:00
.asf.yaml github: master branch protection tune. 2025-05-07 18:37:13 -05:00
.codespell-ignore-lines net/icmpv6: replace net_lock with conn_lock and conn_lock_dev 2025-12-29 09:42:18 +08:00
.codespellrc codespellrc: add ist to ignorelist 2025-10-14 17:42:01 +08:00
.editorconfig .editorconfig: fix character encoding property specification 2025-11-28 19:12:13 +08:00
.gitignore !build: add build-time password generation with mkpasswd tool. 2026-04-14 16:06:30 +08:00
.gitmessage docs/contributing: Add a commit message template 2025-06-03 17:33:24 +08:00
.pre-commit-config.yaml pre-commit: enable codespell checks 2025-05-05 12:34:39 +08:00
.yamllint feat: add a GitHub action to lint the YAML files 2020-12-15 09:52:04 -06:00
AUTHORS AUTHORS: add Donny Jiuzhu 2026-02-25 10:17:40 +01:00
CMakeLists.txt cmake: Enhance .config handling and comparison logic 2026-02-26 09:46:02 -03:00
CONTRIBUTING.md docs: Fix typos, formatting, and numbering in README.md and CONTRIBUTING.md. 2026-03-23 12:05:24 +01:00
INVIOLABLES.md
Kconfig tools/stackusage.py: use toolchain binaries instead of Python libraries 2026-03-17 11:26:44 -03:00
LICENSE style: fix spelling in code comments and strings 2025-05-23 10:48:41 +08:00
Makefile tools: migrate to SPDX identifier 2024-09-10 23:11:11 +08:00
NOTICE Remove the double blank line from source files 2022-02-20 20:10:14 +01:00
README.md docs: Fix typos, formatting, and numbering in README.md and CONTRIBUTING.md. 2026-03-23 12:05:24 +01:00
ReleaseNotes Documentation: move ReleaseNotes 2023-09-26 20:41:00 +08:00

POSIX Badge License Issues Tracking Badge Contributors GitHub Build Badge Documentation Badge

Apache NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOSs (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).

For brevity, many parts of the documentation will refer to Apache NuttX as simply NuttX.

Getting Started

First time on NuttX? Read the Getting Started guide! If you don't have a board available, NuttX has its own simulator that you can run on terminal.

Documentation

You can find the current NuttX documentation on the Documentation Page.

Alternatively, you can build the documentation yourself by following the Documentation Build Instructions.

The old NuttX documentation is still available in the Apache wiki.

Supported Boards

NuttX supports a wide variety of platforms. See the full list on the Supported Platforms page.

Contributing

If you wish to contribute to the NuttX project, read the Contributing guidelines for information on Git usage, coding standard, workflow and the NuttX principles.

License

The code in this repository is under either the Apache 2 license, or a license compatible with the Apache 2 license. See the License Page for more information.