SFTP Access to Assets

How to Configure SFTP Access to Assets | In Ingeniux CMS 10.3, you can add, edit, and remove assets via SFTP.


Prior to Ingeniux CMS 10.3, the only way users could access CMS assets was through the CMS UI. In CMS 10.3+, you can edit, add, and delete assets in Assets Manager via Secure File Transfer Protocol (SFTP).

To configure SFTP access for assets:

  1. Navigate to the root of your CMS installation and open local-appsettings.config in a text editor.
  2. Set the EnableIngeniuxSFTPServer value to true and save your change. This configuration installs a listener endpoint on the base URL of the CMS.

    Enable SFTP Access to Assets in local-appsettings.config

  3. Recycle the CMS ContentStore application pool. The CMS auto-generates private (igxsftp.pem) and public (igxsftp.pub) SSH keys found at [path-to-cms-site-instance]/App_Data/IGXSFTP.
    Troubleshoot: If the keys don't generate, recycle the CMS and the CMS ContentStore. 
  4. Navigate to Administration > Users/Groups.
  5. Add an SFTP group.

    Add SFTP Group

    Note: You do not need to set permissions on SFTP group.
  6. Add at least one user to SFTP group.
  7. Save this new configuration.
  8. Advanced: You can customize the IgxSftpSettings document within your CMS's RavenDB Content Store if you need:

    To change the SFTP port number:

    1. In your browser, navigate to the IgxSftpSettings document within your CMS's RavenDB contentstore (e.g., http://[hostserver]/[cms-instance-name]/ContentStore/studio/index.html#databases/edit?&id=IgxSftpSettings%2F1&database=IGXContentStore).

      Configure IgxSftpSettings

    2. In the Data tab, change the port value from 22 to the port number you want to use.
    3. Click the Save icon and exit RavenDB.

    To use keys other than the ones auto-generated by  Ingeniux CMS:

    1. In your browser, navigate to the IgxSftpSettings document within your CMS's RavenDB ContentStore (e.g., http://[hostserver]/[cms-instance-name]/ContentStore/studio/index.html#databases/edit?&id=IgxSftpSettings%2F1&database=IGXContentStore).

      Configure IgxSftpSettings

    2. In the Data tab, insert the path of the private key value between the quotes on the first line.
    3. Click the Save icon and exit the RavenDB.
  9. Open an SFTP client such as WinSCP or FileZilla.
  10. Connect to your CMS server via SFTP.

    Example:

    Basic SFTP Configuration

    Note: Be sure to connect with one of the users (and password for that user) that you defined as a member of the SFTP group. All managed assets in the Ingeniux CMS Assets Tree display as remote folders in your SFTP client.

  11. Move local folders and assets to the appropriate remote folder(s).
  12. Optional: Verify that the transfer was successful by navigating to Assets > Assets Tree. Your transferred assets display in the Assets Tree as checked-out assets.

This section includes: