Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed spelling, grammar #575

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed spelling, grammar #575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 34 additions & 40 deletions contrib/docs/FTP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# MEGA-FTP - Serve you files as a FTP server with MEGAcmd
This is a brief tutorial on how to configure [ftp](https://en.wikipedia.org/wiki/File_Transfer_Protocol) server.

Configuring a FTP server will let you access your MEGA files as if they were located in your computer.
All major platforms support access to FTP server. See [`Platform`](#platforms) usage.
# MEGA FTP - Serve your files as FTP server with MEGAcmd
This is a brief tutorial on how to configure an [ftp](https://en.wikipedia.org/wiki/File_Transfer_Protocol) server.

Notice: the commands listed here assume you are using the interactive interaction mode: they are supposed to be executed within MEGAcmdShell.
Configuring a FTP server will let you access your MEGA files as if they were located in your computer. All major platforms support access to FTP server. See [`Platform`](#platforms) usage.

Notice: the commands listed here assume you are using the interactive interaction mode: they are supposed to be executed within MEGAcmd shell.

## Serving a folder
Example:
**Example:**
```
ftp /path/mega/folder
```

This will configure a FTP server that will serve "myfolder". It'll show you the URL to access that path. You just use that location to configure access [according to your specific OS](#platforms).
Once you have it configured, you can browse, edit, copy and delete your files using your favourite FTP client or add mount the network location and browse your files as if they were local file in your computer..
Caveat: They are not local, MEGAcmd transparently download/upload decrypt/encrypt those files.
Hence, throughput will be decreased as compared to accessing to local files. Be patient.

Once you have it configured, you can browse, edit, copy and delete your files using your favourite FTP client or add mount the network location and browse your files as if they were local file in your computer.

**Caveat**: They are not local - MEGAcmd transparently downloads/uploads decrypts/encrypts the files. Hence, throughput will be decreased as compared to accessing to local files. Be patient.

## Streaming
You can "ftp" a file, so as to offer streaming access to it:
Expand All @@ -26,21 +27,20 @@ ftp /path/to/myfile.mp4
You will receive an URL that you can use in your preferred video player.

## Issues
We have detected some issues with different software, when trying to save a file into a ftp served locations. Typically with software that creates temporary files.
We will keep on trying to circumvent those.
We have detected some issues with different software when trying to save a file into a ftp served locations, typically with software that creates temporary files. We will keep on trying to circumvent those.

In FileZilla, default 20 seconds timeout (Edit -> Preferences -> Connection) will likely stop uploads before they are completed: once a upload is started, it begins to populate a temporary file. Once completed, the actual upload begins (the file gets transfered to MEGA), but no extra traffic is perceived by FileZilla during this time. If the upload takes longer than 20 seconds, it times out. You might want to increase that number for a correct behaviour.
In **FileZilla**, by default there is a 20 seconds timeout (Edit -> Preferences -> Connection) which will likely stop uploads before they are completed: once a upload is started, it begins to populate a temporary file. Once completed, the actual upload begins (the file gets transfered to MEGA), but no extra traffic is perceived by FileZilla during this time. If the upload takes longer than 20 seconds, it times out. You might want to increase that number for a correct behaviour.

In Linux, using gvfsd-dav (Gnome's default ftp client), we have seen problems when trying to reproduce videos within an FTP served location. Recommended alternative: Use VLC. Open it, and drag & drop the file into VLC window. This will open the FTP URL and start streaming you video.
In Linux, using **gvfsd-dav** (Gnome's default ftp client), we have seen problems when trying to reproduce videos within an FTP served location. Recommended alternative: Use VLC. Open it, and drag & drop the file into VLC window. This will open the FTP URL and start streaming you video.

If you find any more issues, don't hesitate to write to support@mega.nz, explaining what the problem is and how to reproduce it.
If you find any more issues, don't hesitate to write to support@mega.io, explaining what the problem is and how to reproduce it.

## Listing

You can list the ftp served locations typing `ftp`:
You can list the ftp served locations by typing `ftp`:

**FTP SERVED LOCATIONS:**
```
FTP SERVED LOCATIONS:
/path/mega/folder: ftp://127.0.0.1:4990/XXXXXXX/myfolder
/path/to/myfile.mp4: ftp://127.0.0.1:4990/YYYYYYY/myfile.mp4
```
Expand All @@ -51,40 +51,39 @@ These locations will be available as long as MEGAcmd is running. The configurati

## Port & public server

When you serve your first location, a FTP server is configured in port `4990`.
You can change the port passing `--port=PORT` to your ftp command.
When you serve your first location, a FTP server is configured in port `4990`. You can change the port passing `--port=PORT` to your ftp command.

Currently *only passive mode* is available. If your client does not work with passive FTP mode, it won't work.
Data connections will work in the range of ports 1500 to 1600 by default. You can change those passing `--data-port=BEGIN-END`

Data connections will work in the range of ports 1500 to 1600 by default.
You can change those passing `--data-port=BEGIN-END`
By default, the server is only accessible from the local machine.
You can pass `--public` to your ftp command so as to allow remote access.
In that case, use the IP of your server to access to it.

You can pass `--public` to your ftp command so as to allow remote access. In that case, use the IP address of your server to access to it.

## FTPS

Files in MEGA are encrypted, but you should bear in mind that the bare FTP server offers your files unencrypted. \
If you wish to add authenticity to your ftp server and integrity & privacy of the data transfered to/from the clients,
you can secure it with [TLS](https://wikipedia.org/wiki/Transport_Layer_Security). Notice that FTPs is not the same as [SFTP](https://es.wikipedia.org/wiki/SSH_File_Transfer_Protocol), which is a complete different yet unsupported protocol.
Files in MEGA are encrypted, but you should bear in mind that the bare FTP server offers your files unencrypted.

To serve via FTPS, you just need to pass `--tls` and the paths* to your certificate and key files (in PEM format):
If you wish to add authenticity to your ftp server and integrity & privacy of the data transferred to/from the clients, you can secure it with [TLS](https://wikipedia.org/wiki/Transport_Layer_Security). Notice that FTPs is not the same as [SFTP](https://es.wikipedia.org/wiki/SSH_File_Transfer_Protocol), which is a completely different and currently unsupported protocol.

To serve via FTPS, you just need to pass `--tls` and the paths to your certificate and key files (in PEM format):

```
ftp /path/mega/folder --tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key
```

*Those paths are local paths in your machine, not in MEGA.

Currently, MEGAcmd only supports one server: although you can serve different locations, only one configuration is possible.
The configuration used will be the one on your first served location.
If you want to change that configuration you will need to stop serving each and every path and start over.
*Paths are local paths in your machine, not in MEGA.*

Currently, MEGAcmd only supports one server: although you can serve different locations, only one configuration is possible. The configuration used will be the one on your first served location. If you want to change that configuration you will need to stop serving each and every path and start over.

## Stop serving

You can stop serving a MEGA location with:
```
ftp -d /path/mega/folder
```
If successfully, it will show a message indicating that the path is no longer served:
If successful, it will show a message indicating that the path is no longer served:
```
/path/mega/folder no longer served via ftp
```
Expand All @@ -95,7 +94,7 @@ All major platforms support accessing/mounting a ftp location. Here are some ins

### Windows

This instructions refer to Windows 10, but they are similar in other windows.
These instructions refer to Windows 10, but they are similar in other Windows versions.

Open an Explorer window, and then do right click on "This PC", and then "Add a network location...".

Expand All @@ -109,9 +108,7 @@ And select "Log on Anonymously"

![ftpConnectToServerWin2.png](pics/ftpConnectToServerWin2.png?raw=true "ftpConnectToServerWin2.png")

Then, you should see the new location in the navigation panel now.
Windows FTP client does not allow writing, if you wish to modify your files you should either use an alternative client
(like FileZilla), or perhaps serve your files using WEBDAV instead of FTP.
Then, you should see the new location in the navigation panel now. Windows FTP client does not allow writing, if you wish to modify your files you should either use an alternative client (like FileZilla), or perhaps serve your files using WEBDAV instead of FTP.


### Mac
Expand All @@ -124,14 +121,11 @@ Then enter the URL MEGAcmd gave you

![ftpConnectToServerMac.png](pics/ftpConnectToServerMac.png?raw=true "ftpConnectToServerMac.png")

At the moment of writing this tutorial, there is no authentication mechanisms,
hence you don't need to worry about providing a user name/password. Just proceed if you are prompted with default options.
You should see the new location in the navigation panel now.
At the moment of writing this tutorial, there is no authentication mechanisms, hence you don't need to worry about providing a user name/password. Just proceed if you are prompted with default options. You should see the new location in the navigation panel now.

### Linux

This instructions are for Nautilus, it should be similar using another file browser.
Notice that `gvfs` currently does not support FTPs
This instructions are for Nautilus, it should be similar using another file browser. Notice that `gvfs` currently does not support FTPs

Click on File -> Connect to Server:

Expand Down