(ftp-settings)=
# FTP settings

You can index files remotely using FTP.

Here is a list of FTP settings:

| Name              | Environment Variable        | Default value   | Documentation                      |
|-------------------|-----------------------------|-----------------|------------------------------------|
| `fs.provider`     | `FSCRAWLER_FS_PROVIDER`     | `"local"`       | Set it to `"ftp"` for FTP crawling |
| `server.hostname` | `FSCRAWLER_SERVER_HOSTNAME` | `null`          | Hostname                           |
| `server.port`     | `FSCRAWLER_SERVER_PORT`     | `21`            | Port                               |
| `server.username` | `FSCRAWLER_SERVER_USERNAME` | `anonymous`     | {ref}`ftp_login`                   |
| `server.password` | `FSCRAWLER_SERVER_PASSWORD` | `null`          | {ref}`ftp_login`                   |


```{deprecated} 3.0

The `server.protocol` setting is deprecated. Use `fs.provider` instead.
```

(ftp_login)=
## Username / Password

Let's say you want to index from a remote server using FTP:

-  FS URL: `/path/to/data/dir/on/server`
-  Server: `mynode.mydomain.com`
-  Username: `username` (default to `anonymous`)
-  Password: `password`
-  Provider: `ftp`
-  Port: `21` (default to `21`)

```yaml
name: "test"
fs:
  provider: "ftp"
  url: "/path/to/data/dir/on/server"
server:
  hostname: "mynode.mydomain.com"
  port: 21
  username: "username"
  password: "password"
```