FTP

FTP (or File Transfer Protocol) is a protocol that allows you to transfer files from a server to a client and vice versa (as FTP uses a client-server architecture). FTP is among the oldest protocols as its origins can be traced as far back as 1971 according to RFC 114.

Variants of FTP also exist, including SFTP (SSH FTP, not to be confused with Simple FTP) and FTPS (FTP with TLS). SFTP, as the name implies, is done over SSH. FTPS is plain FTP with TLS encryption.

Alpine Linux has various FTP clients and servers that you can install and use, including the following:

• vsftpd (server)
• ncftp (client)

Plenty of other clients also exist, but the ones mentioned above are the only ones covered. See #Clients for more details.

Servers

vsftpd

In Alpine Linux the default FTP server is vsftpd. However, it's not widely used due to common hosting panels not handling it's configuration management. On the other hand, vsftpd is more secure and doesn't require many updates.

vsftpd also claims it's the "most secure and fastest FTP server for UNIX-like systems". It's the default FTP server in NimbleX, Slackware, and many other Linux distributions. In addition, it's also recommended because of relatively easy configuration.

Below is a list of features vsftpd has:

Feature	Value/Name	Notes
Configuration file	/etc/vsftpd/vsftpd.conf	The default config is stock from vsftpd
Default Path For Files	/var/lib/ftp	Because anonymous access is enabled by default, this is the daemon's default home directory
Log Files	/var/log/vsftpd.log	Configurable in vsftp.conf
User Running The Service	vsftpd	Alpine does not have an ftp user; it uses a group with the same name instead.
Group(s) to common to	vsftpd	Used to share things among others daemons or services, like Redis or Apache

Limitations

• SFTP is not supported

Installation

To install and run vsftpd, simply run apk add vsftpd. Optionally install the vsftpd-doc package alongside for documentation.

To enable vsftpd on startup and start it now, run the following commands.

rc-update add vsftpd default
rc-service vsftpd start

Configuration

The default configuration is not ideal because anonymous access is enabled by default and only IPv4 support is enabled. Therefore, the default configuration should not be used in a production environment. Some common server configuration schemes include allowing anonymous access of files, user system FTP services, and virtual users (on the server end).

Per-user FTP files can be supported by special directive in the vsftp.conf file using user_sub_token. For example, this can be set to something like /home/$USER/public_ftp if we enable it (process are described below in further section "vsftpd configuration")

Managing vsftpd

Starting vsftpd: After the installation vsftpd is not running. As we said in first section, was started already but if you want to start vsftpd manually use:

rc-service vsftpd start

If starting vsftpd went OK, you should see output similar to the following:

 * Caching service dependencies ...                           [ ok ]
 * Starting vsftpd...                                         [ ok ]

Stopping vsftpd: if you want to stop the web server use stop in the same way of previous command:

rc-service vsftpd stop

Restarting or reloading vsftpd: After changing the configuration file, you must either restart or reload vsftpd in order for the new configuration to take effect. You can run one of the following commands below to achieve the desired effect:

rc-service vsftpd restart

rc-service vsftpd reload

The latter reloads vsftpd's configuration file while the former restarts vsftpd entirely. The latter might be preferred as it prevents having to reload vsftpd entirely.

If you restarted vsftpd, there should be output similar to the following:

 * Stopping vsftpd...                                         [ ok ]
 * Starting vsftpd...                                         [ ok ]

If you reloaded vsftpd, the output will be similar to the following instead:

 * Reloading vsftpd...                                        [ ok ]

Using the proper runlevel: using the "default" runlevel should work in most cases, although there might be custom runlevels present and it might be more desirable to add vsftpd to a runlevel other than "default". However, keep in mind that runlevels aren't present in Docker containers because Alpine is used mostly in Docker.

To add vsftpd to a runlevel, use the following command:

rc-update add vsftpd [runlevel]

Where [runlevel] is the name of the runlevel you want to add the vsftpd service too. For example, if you want to add vsftpd to the "default" run level, run rc-update add vsftpd default

Testing vsftpd

This section is assuming that vsftpd is running. At the moment, there might not be the ftp user allowed or even available, but the server is up and running.

You can use netcat to test if a connection to the server is successful:

nc -zv [server_address]

Be sure to change [server_address] with the actual IP address of the server. The common response will be OPEN if the server is running. If you receive another response, review your server configuration.

Clients

Because FTP uses a client-server architecture, you will need an FTP client if you want to interact with an FTP server. Alpine provides several packages for command-line FTP clients:

• lftp. See #lftp for more details.
• ncftp

If you prefer a graphical client, check out the following:

• pcmanfm. See #PCManFM with GVfs

Some web browsers also support FTP, although most major brows, such as Chrome and Firefox, have removed support for the protocol.

lftp

lftp is a sophisticated file transfer program that supports a number of network protocols, including FTP, HTTP, SFTP, FISH, and BitTorrent. It also has the following features:

• Job control
• Support for bookmarks
• Support for a built-in mirror command
• Support for parallel file transfers
• Uses readline for input

Feature	Value/Name	Notes
Package Name	lftp	Install: apk add lftp
Manpages and -doc Packages	vsftpd-doc	Install: apk add lftp-doc
System Configuration Files	/etc/lftp.conf	Little to no customizations are made by Alpine
User Configuration Files	~/.lftprc, ~/.lftp/rc	The former is read first while the latter is read second if the former was not found.

Installation

To install lftp, run apk add lftp

lftp has been provided in the main repository since Alpine 3.6, so it's a supported package that's ready for production use.

Configuration

The main configuration file, /etc/lftp.conf, comes with different examples and comments. On startup, lftp reads /etc/lftp.conf, ~/.lftprc, and ~/.lftp/rc in that exact order. These files are used to set system-wide and user-specific settings.

In the configuration file, use the command set followed by the name of the setting followed by its value. Use on/off for boolean values. For example:

set ftp:ssl-force on
set ssl:verify-certificate on
set ftp:use-feat off
set ftp:ssl-protect-data on

Specific settings can be set for specific servers only. Append a slash (/) in front of the server name for a specific server.

set ftp:use-feat off /example.com
set ftp:ssl-force on /example.com

Note: The closure for dns:, net:, ftp:, http:, and hftp: domain variables is currently just the host name as you specify it in the open command (with some exceptions where closure is meaningless, e.g., dns:cache-size). For some cmd: domain variables the closure is the current URL without path. For other variables, it is currently not used. See examples in the sample lftp.conf.

More Info

By default, lftp is not very verbose about operations it performs in the background. If you want more output, you can use the 'debug' command (without the 'set' command):

• debug 5 will display the full debug output.
• debug 3 will only display greeting messages and error messages.

Note that using the -d switch from the command line will override any previous debug settings and the full debug output will be displayed.

If you prefer some commands to be called by another name, you can set aliases using the alias command. The syntax is as follows:

alias [name] [command]

[name] is the name of the lftpd alias and [command] is the name of the lftpd command. A couple of examples are shown below:

alias dir ls
alias less more
alias zless zmore
alias bzless bzmore
alias reconnect "close; cache flush; cd ."
alias edit "eval -f "get $0 -o ~/.lftp/edit.tmp.$$ && shell \\"cp -p ~/.lftp/edit.tmp.$$ ~/.lftp/edit.tmp.$$.orig && vim ~/.lftp/edit.tmp.$$ && test ~/.lftp/edit.tmp.$$ -nt ~/.lftp/edit.tmp.$$.orig\\" && put ~/.lftp/edit.tmp.$$ -o $0; shell rm -f ~/.lftp/edit.tmp.$$*"

The last alias should all be in one line. It gets a remote file, opens it with vim, and places the modified file back on the server. This can be very convenient when a file needs to be quickly edited and updated on the remote server.

Example usage

Below is an example of a mult-part download over SFTP:

$ lftp -e 'pget -c -n 5 /path/to/file' sftp://username@server

Breakdown:

• -e: execute a command
• pget: the command for partial download, in addition to its options:
  • -c: option to resume
  • -n: option for number of parts
• sftp://username@server: server URL

PCManFM with GVfs

You can use the PCManFM file manager with the gvfs plugin as a graphical FTP client. To connect to an FTP server, you can do the following:

1. From the menubar, go to Go > Connect to a server
2. Choose the FTP protocol and input your username (path is optional)
3. After a while you will input the password for the username you input

See Also

• PXE boot