All Products
Search
Document Center

Object Storage Service:Install OSS FTP

Last Updated:Mar 19, 2026

OSS FTP (ossftp) lets you access OSS buckets through any standard FTP client. This page explains how to download, install, and configure OSS FTP on Windows, Linux, or macOS.

Prerequisites

Before you begin, ensure that you have:

  • An Alibaba Cloud account with at least one OSS bucket

  • A bucket endpoint in the format BucketName.Endpoint (for example, examplebucket.oss-cn-hangzhou.aliyuncs.com)

  • TCP ports 2048 and 8192 available on the local computer

  • (If serving other users over the network) Firewall rules that allow inbound traffic on TCP ports 2048 and 8192

Quick start

  1. Download the installation package for your OS (see Download the installation package).

  2. Extract the package to a path that contains no Chinese characters.

  3. Launch OSS FTP for your OS (see Run OSS FTP).

  4. Open http://127.0.0.1:8192 in a browser, enter your bucket endpoint, and click Save config, then Restart.

Download the installation package

OSS FTP 1.2.0 is available for Windows, Linux, and macOS.

Windows

Download ossftp-1.2.0-win.zip.

The Windows package bundles Python 2.7. No separate Python installation is required.

Linux

Download ossftp-1.2.0-linux-mac.zip.

Linux includes Python 2.7 or Python 3.x by default. The package contains only the required dependent libraries.

macOS

Download ossftp-1.2.0-linux-mac.zip.

macOS includes Python 2.7 or Python 3.x by default. The package contains only the required dependent libraries.

Extract the package

Extract the downloaded .zip file to a local directory.

Important

The extraction path must not contain Chinese characters. OSS FTP fails to start if the path includes Chinese characters.

Run OSS FTP

Start OSS FTP for your operating system:

OSAction
WindowsDouble-click start.vbs.
LinuxRun bash start.sh.
macOSDouble-click start.command.
On Windows, if OSS FTP does not start, upgrade Internet Explorer to a newer version, or set a different browser as the default.

After OSS FTP starts, it opens two TCP ports on the local computer:

PortPurpose
2048FTP server — receives FTP requests
8192Web server — hosts the graphical management interface
To serve other users on the network, open both ports in your firewall configuration.

Configure OSS FTP

  1. Open the graphical management interface in a browser:

    DeviceURL
    Local computerhttp://127.0.0.1:8192
    Remote devicehttp://<IP address of the Linux server>:8192
  2. Set the configuration parameters:

    ParameterExampleDescription
    ossftp address127.0.0.1IP address of the client using the FTP service. If the client runs on the local computer, keep the default value.
    ossftp port2048Port that receives requests for OSS FTP. Keep the default value if it does not conflict with other ports.
    ossftp passive ports start51000Starting port number of the passive port range. Keep the default value if it does not conflict with other ports.
    ossftp passive ports end53000Ending port number of the passive port range. Keep the default value if it does not conflict with other ports.
    ossftp log levelINFOLog output level. Valid values: DEBUG | INFO | WARNING | ERROR | CRITICAL. See Log levels for details.
    Bucket endpointsexamplebucket.oss-cn-hangzhou.aliyuncs.comEndpoint used to access the bucket, in the format BucketName.Endpoint. Separate multiple endpoints with commas (,).
    LanguagecnDisplay language for OSS FTP.

    OSS FTP configuration interface

  3. Click Save config, then click Restart for the settings to take effect.

    Important

    Do not click Exit. Clicking Exit stops OSS FTP.

Log levels

LevelDescription
DEBUGRecords detailed information events. Use for debugging.
INFORecords events that occur during normal operation.
WARNINGRecords abnormal events that do not affect system behavior.
ERRORRecords abnormal events that affect the system but not its reliability.
CRITICALRecords events that cause OSS FTP to stop working.