Media Source Type - FTP
Last updated Oct 10th, 2026 | Page history | Improve this page | Report an issue
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$194 per month—let's make that $500!
Learn moreFTP¶
Type name: File Transfer Protocol
Reads and writes files on a remote server over FTP. Built into the core (based on Flysystem's FTP adapter) and available in the Media Source type list without installing anything extra.
Properties¶
| Property | Description |
|---|---|
host |
FTP server hostname |
username |
Account name |
password |
Account password |
port |
FTP port |
root |
Remote starting directory |
passive |
Use passive mode |
ssl |
Use FTPS (SSL/TLS) |
timeout |
Connection timeout in seconds |
Usage¶
Create a Media Source as described in Adding a Media Source, pick File Transfer Protocol as the type, fill in the connection properties, then assign the source to TVs or use it in code. See Media Sources for the general concept.
See Also¶
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$194 per month—let's make that $500!
Learn more