a4b6b8b8bf
Provide a complete documentation guide for the ftpd (FTP server) network utility in Documentation/applications/netutils/ftpd/index.rst, replacing the previous 6-line placeholder stub. Includes: - Protocol architecture overview (control/data connection separation, multi-session worker pthreads, VFS mapping) - Security considerations regarding unencrypted plaintext FTP credentials, mandatory credential hardening, home directory isolation, and encrypted password authentication - Comprehensive supported RFC 959 / RFC 2428 / RFC 3659 FTP commands reference table - Configuration options table and networking prerequisites (CONFIG_NETUTILS_FTPD, worker stack size, buffer sizes) - NSH terminal usage (ftpd -4 / -6, ftpd_stop) with address-family flag requirements and configured account placeholders - External client connection walkthroughs (FTP CLI, cURL) using configured account and anonymous workflows - Public C API reference for types, account flags, and lifecycle functions (ftpd_open, ftpd_adduser, ftpd_session, ftpd_close) - Complete, runnable C application example demonstrating multi-user server setup, signal-driven termination (SIGINT/SIGTERM) with atomic sig_atomic_t state, POSIX kill stop routine, and credential placeholders - Embedded design and resource tuning guidelines (stack sizing, flash/SD card I/O buffering, and NAT passive mode) Addresses #11081 Assisted-by: Google Gemini Signed-off-by: Swatantra Yadav <maverickswatantra@gmail.com> |
||
|---|---|---|
| .github | ||
| arch | ||
| audio | ||
| binfmt | ||
| boards | ||
| cmake | ||
| crypto | ||
| Documentation | ||
| drivers | ||
| dummy | ||
| fs | ||
| graphics | ||
| include | ||
| libs | ||
| mm | ||
| net | ||
| openamp | ||
| pass1 | ||
| sched | ||
| syscall | ||
| tools | ||
| video | ||
| wireless | ||
| .asf.yaml | ||
| .codespell-ignore-lines | ||
| .codespellrc | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmessage | ||
| .mcp.json | ||
| .pre-commit-config.yaml | ||
| .yamllint | ||
| AUTHORS | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| INVIOLABLES.md | ||
| Kconfig | ||
| LICENSE | ||
| Makefile | ||
| NOTICE | ||
| README.md | ||
| ReleaseNotes | ||
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.