FTP Synchronize

From Notepad++ Wiki
Jump to: navigation, search
Remote editing using the FTP Synchronize plugin

Overview of FTP Folders

The FTP Folders panel of Notepad++ lets you connect to an FTP server so you can upload file to the server and download files from the server. An FTP server is the typical way to upload web pages to a web server. If you use a web hosting company, see their documentation for more information about FTP access for your hosting account.

Each server you connect to is stored in a profile. When you initiate a connection, you select the profile for the server you want to use. If you use the plugin for the first time, the Connect button is inactive, because you need to define at least a profile to enable it. While you are connected, you can browse the files and folders on the server. A message window shows the interactions between Notepad++ and the server.

Remember that FTP connections are not encrypted. Any username and password information you enter may be seen while crossing the network. Any files you upload or download from the server may be seen as it crosses the network. Never log in to an FTP server with the root or administrator account. Never upload or download files that contain administrator account passwords. Always have a back up of the files on the server in a safe place.

How to show, hide, and move the FTP Folders panels

  • To show the FTP Folders panel, go to Plugins -> FTP_synchronize in the menu bar and select Show FTP Folders.
  • To hide the FTP Folders panel, click the close button in the title bar of the FTP Folders panel.
    • You can also hide the FTP Folders panel by going to Plugins -> FTP_synchronize in the menu bar and deselecting Show FTP Folders.
  • To hide just the FTP Messages panel, click the close button in the title bar of the FTP Message panel or click the Show messages icon at the top of the FTP Folders panel (the one on the far right).
  • To show the FTP Messages panel after you've hidden it, click the Show messages icon at the top of the FTP Folders panel (the one on the far right).
    The FTP Folders and FTP Message panels are dockable. This means you can position them at different locations around the edge of the Notepad++ application window (top, bottom, left, or right). You can also float the panels as separate windows outside or on top of the main Notepad++ window.
  • To move a panel, click and drag its title bar. A dotted outline will indicate where the panel will dock when you release the mouse button. Experiment with the panel positions to find a layout that works best for you.

The eight buttons in the FTP Folders panel

  1. The connect button initiates a connection to a server. Once connected, click the button again to disconnect.
  2. The download button downloads a file from the server. The default location for downloaded files is loke: C:\Program iles\Notepad++\plugins\FTP_synchronizeA\user@www.example.com\path\on\server\filename.html
    • You can set the default storage location for FTP Folders and set a different storage folder for any connection profile (see below).
  3. The upload button uploads the current file to the server. The file must be saved before being uploaded.
  4. The refresh button updates the file and folder listing displayed in the FTP Folders panel.
  5. The abort button stops the current operation.
  6. The issue raw command button lets you interact directly with the FTP server. You must enter valid FTP commands. See either the FTP specification or this FTP tutorial.
  7. The settings button lets you manage profiles and control how FTP Folders operates.
  8. The show messages button lets you show and hide the FTP Messages panel.

How to create a connection profile

IMPORTANT: if using FTP_Synchronize for the first time, you must create at least one connection profile before you can connect.

  1. Click the settings button.
  2. In the Profiles tab of the settings window, click the New button at the bottom of the profiles list.
  3. In the profile text box, type a name for the profile and click the Rename button. This name will be displayed when you click the connect button.
  4. In the address text box, type the address for the FTP server. This can be a DNS name or an IP address.
    • If you know the TCP port of the server is different from the standard port 21, enter the server's port number in the port text box.
  5. In the username text box, type the username you want to use to connect to the FTP server.
    • You can type the password for the FTP account in the password text box. It will only show a large dot for each character in your password so that someone looking at your screen can't see your password. If you want, you can instead check the "Ask for password" box to be prompted for the password each time you try to connect to the FTP server.
  6. The timeout value of 30 is sufficient for most users. If you need to change it, you can enter a different value.
  7. If you need to start in a folder other than your home folder, you can enter an initial directory in the initial directory text box. A common initial directory is public_html. If you're not sure, leave the text box blank.
  8. Most users are fine with the default connection mode of passive. If you know your server uses an active connection, you can change this setting. If you have trouble connecting, try changing this setting after you have verified your username and password are correct.
  9. Enabling the subtree root folder check box will do some stuff.
  10. Enabling the enable keep alive check box will periodically send a command to the server so that the server won't close the connection after a period of inactivity. It is a good idea to check this box.
  11. Enabling the use profile cache check box will allow you to specifiy a location on your computer to save files you download from the FTP server in this profile.
  12. When you're finished making changes, click the Apply button. If you are connected to the server, you will have to disconnect and reconnect for the changes to take effect.
  13. Click the OK button to close the settings window.

How to edit and delete a profile

  • To edit a profile, click the settings button and then select the profile from the profiles list. If you want to change the name, edit the name in the profile box and click the Rename button. If you want to change other settings, do so and then click the Apply button. If you are connected to the server, you will have to disconnect and reconnect for the changes to take place.
  • To delete a profile, click the settings button, select the profile from the profiles list, and click the Delete button. If you delete a profile while connected you won't be disconnected. However if you delete all profiles while connected, the connect button will be disabled and you won't be able to disconnect from the server.