FTP Integration

Abstract

You can upload content directly from Paligo to a web server via FTP (File Transfer Protocol). Set up the Paligo to FTP integration so that Paligo can connect to the web server, and then you can publish.

paligo-to-FTP-small.jpg

With the FTP (File Transfer Protocol) integration, you can publish your Paligo content, such as an HTML5 help center, directly to your web site.

Before you can publish from Paligo to a web server, you need:

  • Web hosting space

  • A URL for the domain (or its IP address)

  • User account and password for access to the domain. The user account must have read/write access to the folder that will receive the content from Paligo.

When you have these, you can set up Paligo's FTP integration settings and publish to your web site:

This will allow Paligo to publish content to your web server. When you publish, your content is uploaded as files, such as HTML or PDF. It is not zipped, so there is no need to unzip it on your web server.

To connect Paligo to your web server via FTP (File Transfer Protocol):

  1. Log in to Paligo via a user account that has administrator permissions.

  2. Select your profile name in the upper right corner to display a menu, and then select Settings.

  3. In the Settings view, select the Integrations tab.

  4. Find the FTP settings and select Add.

    Note

    Add is only available the first time you set up an integration. After that, Add is replaced by Change.

    Paligo displays the FTP integration settings:

    FTP integration settings dialog. It has Host, Username, Password, and Destination folder settings.
  5. Enter the Host details. This can be the domain URL or the IP address of the domain.

  6. Enter the Username for the user account that will be used to access the domain.

    Note

    The user account must have read and write access to the folder that will receive the content from Paligo.

  7. Enter the Password for the user account.

  8. In the Destination folder field, enter the directory path for the folder that you want Paligo to upload content to.

    For example:

    Folder 1/Folder 2/

    To upload the content directly to the root folder of the domain, leave the Destination folder field empty.

  9. Use the Erase destination folder contents on publish checkbox to control what happens to any existing content in the destination folder.

    • Check the box if you want Paligo to delete the existing content before it uploads the new content via FTP.

    • Clear the box if you want Paligo to leave the existing content in place. When Paligo publishes via FTP, the destination folder will contain the existing content and the new uploaded content.

  10. Select Save.

  11. Select the Change button for the FTP integration.

  12. Select Test Settings to run a connection test. If the settings are correct, Paligo will show a green success notification.

    If the connection test fails, Paligo shows a red failure notification. Check each connection setting carefully, to make sure you have not made any mistakes and try again. If the connection test continues to fail, contact Paligo support for assistance.

You can publish content from Paligo to your web server via FTP. The process is very similar to "regular" publishing. You create your publication and topics, and set up a layout for the type of output you want, such as PDF, HTML5, etc. Then you choose the publication settings and publish. Paligo generates your content and uploads it to your web server.

Note

Your browser will also download a zip file of the content. You can keep this as a local backup.

To publish to your web server, the FTP integration settings need to be in place. You also need to have a publication and layout set up to create the output you want, for example, an HTML5 help center. You can then publish from Paligo to your web server:

  1. In Paligo, select the options menu ( ... ) for the publication that you want to publish, and then select Publish.

    Publish document dialog showing settings for different output types, languages, profiling attributes, variables, and upload output.
  2. On the Publish document dialog, select the type of output you want, for example, HTML5.

  3. Choose the layout that you want to use for publishing. The settings in the layout are applied when Paligo generates the output.

  4. Choose the Languages to publish to. If you do not have any translations, you can only select the original/source language.

  5. If you have set filters (Profiling attributes) on topics or elements, and/or have used variables, choose which values to use for the publication. See Filters (Profiling) and Variables to learn how to use these features.

  6. In the Upload output section, check the Upload via FTP box. By default, Paligo will upload the output to the folder that is specified in the Paligo FTP integration settings.

    The upload output settings on the publish document dialog. There are options for uploading to GitHub, Bitbucket, Amazon Web Services S3, and via FTP. FTP is selected.

    You can publish to a different folder if required. Select the Edit icon next to Upload via FTP, and then select the folder on the Edit dialog. The settings you choose will only be used for this individual publishing process. Any future publishing will revert back to using the folder that IS defined in the integration settings.

    FTP edit dialog has a destination folder field. You can set a different destination folder just for this particular publication process.
  7. Select Publish document.

    Paligo generates the output, applying the settings from the layout and the Publication document dialog in the process. When the output is created, it is downloaded in your browser as a zip file. The output contents in the zip file is also published directly to your website via FTP.