Change log

FTP access format

Treepl CMS allows you to access site files through secure SFTP. In this article you will learn how to connect to your Treepl website via SFTP as a reseller and/or admin user, as well as learn about Treepl's file structure.

0

Requirements

In order to connect to your Treepl CMS website through FTP you would need to have:

  • Live or trial website on Treepl CMS
  • FTP Client

Credentials

All Treepl sites’ FTP credentials use the following pattern, using the sites’ current primary domain (or trial site URL) and the Reseller's, or Admin's, email address:

Version 6.9.1

With the upcoming release of v6.10 the FTP protocol and credentials format is changing (as per the documentation below) with a move to SFTP (from FTPS), host names per data center and replacing the previous | character with an @ character in the username.
eg: [sitename].treepl.co|[reseller/admin-email-address]
to: [sitename].treepl.co@[reseller/admin-email-address].
Meanwhile, if you are configuring any FTP connection for sites still on v6.9.1 you'll need to continue using this format:

Protocol:
FTPS (FTP over TLS/SSL)
Port:
21
Hostname:
[sitename].treepl.co
or
[sitename].trialsite.co
Username:
[sitename].treepl.co|[reseller/admin-email-address]
or
[sitename].trialsite.co|[reseller/admin-email-address]
Password:
[reseller/site-password]

Version 6.10

Data Centers: US, CA

Protocol:
SFTP
Port:
22
Hostname:
sftp-na.trialsite.co
Username:
[primary site domain/trial site URL]@[reseller/admin-email-address]
Password:
[reseller/site-password]

Data Centers: EU, UK

Protocol:
SFTP
Port:
22
Hostname:
sftp-eu.trialsite.co
Username:
[primary site domain/trial site URL]@[reseller/admin-email-address]
Password:
[reseller/site-password]

Data Centers: AU

Protocol:
SFTP
Port:
22
Hostname:
sftp-au.trialsite.co
Username:
[primary site domain/trial site URL]@[reseller/admin-email-address]
Password:
[reseller/site-password]

Example credentials:

Protocol:
SFTP
Port:
22
Hostname:
sftp-au.trialsite.co
Username:
mydomain.com.au@info@mydomain.com.au
Password:
#ABC123

The correctly compiled FTP credentials will also be displayed in your site's settings page via your Treepl Portal, under the FTP tab.

Replace [text in the brackets] with the relevant sitename/domain name (as shown in your Treepl Portal), username and password and use these credentials in your FTP client to connect to your website.

Admin Users

All Reseller level admin users of your site will have FTP access following the same credential pattern as described above but using their site admin email address and site admin password.

Additional admin users will have full site permissions except for FTP access. If FTP access is required for added admin users, be sure to create a User Role with FTP permissions enabled.

File Naming Best Practises

When creating a page (or file) via FTP (or via the admin File Manager), please follow these best practises to avoid unpredictable result and/or errors:

1
Duplicate File Names

Do not create files with the same name but with different variations of the same file extension. Eg; myfile.html and myfile.htm

Doing so may result in inconsistent updating of file content when one or the other file is changed, along with other errors.

2
Empty File Names

Do not create files with an empty name (eg: .htm, .html).

The CMS logic of creating and changing the page via FTP, or via the admin File Manager, will ignore such files and will not result in the creation of a page.

3
Reserved URL Characters

Avoid using % and # characters in file names - particularly where these file names may be referenced in the URL (ie: as a link to a page or file). These characters are used in standard URL operations, therefore, including them in links/URLs can cause conflicts with existing URL constructs.

If these characters are to be used in your file naming, ensure any links/paths to such files are correctly URL encoded.

The URL encoding for these characters is listed below:

% –> %25
# –> %23

You can either manually encode these characters or make use of the Liquid filter url_encode.

Manual example:

// actual file name
<a href="/path/to/#my100%file.html">My Link</a>

// encoded file name
<a href="/path/to/%23my100%25file.html">My Link</a>

Liquid example:

{% assign fileSlug = "#my100%file.html" %}
<a href="/path/to/{{fileSlug | url_encode}}">My Link</a>
<a href="/path/to/%23my100%25file.html">My Link</a>

4
Folder and File Name Case Sensitivity

The Treepl CMS file system is case-sensitive and will resolve folders and files only from a matching-case request. Be sure to use matching letter case in your file paths and links.

For more information on system case sensitivity, see the File System article here.

Directory Structure

You have the freedom of creating your own folders and files within your sites directory structure. Keep in mind though, that Treepl CMS has certain directories/folders within a sites file structure which are utilised for system functionality (indicated below by the Treepl CMS icon ) and are either not accessible via the File Manager or should not be edited as they will be overriden with any version updates affecting those files.

The default system directory structure (and FTP access) is outlined below:

  • ROOT
  • cms-assets
    • css
      • event-calendar.min.css
      • jquery.fancybox.min.css
      • main.css
    • includes
      • event-calendar.inc
    • js
      • event-calendar.min.js
      • jquery.fancybox.min.js
      • payment.js
  • Contact
    • ContentTemplates
      • Master.html
    • EmailTemplates
      • System Default.html
    • Forms
      • [your form name].html
    • MenuLayouts
      • [your_menu_alias]
        • Default
          • item.layout
          • menu.layout
          • sub_items.layout
    • ModuleLayouts
      • Custom
        • [YourCustomModule]
          • Detail_Detail.html
          • List.html
      • System
        • Banner
          • List.html
        • BannerGroup
          • List.html
        • Blog
          • Blog List Layout.html
          • General Blog Layout_Detail.html
        • BlogPost
          • List.html
          • Post Detail_Detail.html
        • Event
        • EventGroup
        • FAQGroup
          • List.html
        • FAQQuestion
          • List.html
        • GallerySlider
          • Detail_Detail.html
          • List.html
        • ItemAuthor
          • Detail_Detail.html
          • List.html
        • Page
          • Page Detail_Detail.html
          • Site Search List.html
        • PageFolder
          • Folder Detail_Detail.html
        • Slide
          • List.html
    • Pages
      • home.html
    • Snippets
    • SystemEmails
      • confirm-email-notification.html
      • invoice.html
      • password-retrieve-email.html
      • secure-zone-login-details.html
      • workflow-notification.html
    • SystemPages
      • 401.html
      • 403.html
      • 404.html
      • default-page.html
      • email-confirmation.html
      • error-page.html
      • form-submission-results.html
      • request-reset-password-result.html
      • request-reset-password.html
      • reset-password.html
    • WorkflowEmails
  • _tmp


Related Articles

  • Site Settings & Management
    Domains

    The Treepl CMS Domain settings allow you to control default domain, landing pages, domain authentication for system emails along with country and cultural settings like number and currency formatting.
  • Site Settings & Management
    Site Globals

    Site Globals, under ‘Settings’, is where you can set up customised data points for your...
  • Site Settings & Management
    System Pages

    System Pages, under 'Settings', is where you’ll find all those pages required by certain system...
  • Site Settings & Management
    Payment Settings

    Integrate various payment gateways, for multiple countries and currencies, into Treepl CMS for form payments, subscriptions and eCommerce workflows.
  • Site Settings & Management
    Admin Users

    Admin Users, found under ‘Settings’, is where you can control administrator access to your website management and content.
  • Site Settings & Management
    Admin User Roles

    Admin User Roles provide fine-grain control over permissions for users granted with admin access.
  • Site Settings & Management
    Admin Menu Configurator

    Customise the way admin users find and access site content and settings by configuring the admin menu with your own structure, labels, icons and links.
  • Site Settings & Management
    URL Redirects

    URL Redirects, found under ‘Settings’, enable you to set up 301 permanent redirects from a prior, or constructed, URL to another URL (within your domain/s).
  • Site Settings & Management
    Sitemap.xml / Robots.txt

    The Sitemap feature allows you to manage the sitemap.xml content, which lists your site’s important pages/items, their priority and last modified date, in XML format, for SEO and site indexing purposes.
  • Site Settings & Management
    SEO

    Configuring these settings will help search engines and accessibility systems better understand the context of your website.
  • Site Settings & Management
    Misc Settings

    These various site-wide settings allow you to further control and customise the way your website functions, both in the admin and on the front-end.
  • Site Settings & Management
    Frontend API Restrictions

    Enable access to various frontend API endpoints and individually configure user permissions and access rules.
  • Treepl Portal
    Trial Sites

    Trial Sites are your Treepl CMS development environments for starting new site projects, before you publish to a custom domain name.
  • Treepl Portal
    Live Sites

    Live sites are your published Treepl CMS instances that have been activated, have commenced a billing subscription and/or have a custom domain name assigned to them.
  • About Treepl CMS
    File System

    Most of the content management related assets and files used in Treepl CMS are accessible in the file system either via the admin File Manager or via FTP.
  • About Treepl CMS
    Trial Sites vs Live Sites

    Site Performance & Resources Currently, there are no differences in performance or resources limits between...
  • eCommerce
    Settings

    These various eCommerce settings allow you to further control and customise the way your website functions, both in the admin and on the front-end, in terms of eCommerce functionality.
  • Site Settings & Management
    Empty Cache

    Clear the server-side cache for generated ‘ImageProcessor’ images throughout the site.
  • Website Templates
    *Bikes

  • Website Templates
    *Clothing Store

  • Website Templates
    Coffee

  • Website Templates
    *Coworking

  • Website Templates
    Digital Agency

  • Extensions
    Direct Billing

    Allow your customer to pay Treepl CMS directly for their site plan from the admin, as well as activating the site and assign their primary domain name (if the site is still in Trial Site mode).
  • Website Templates
    Furniture

  • Extensions
    Granular White-labeling

    An addition to the regular white-labeling feature, this extension provides branding controls on an individual site, allowing you to customise a site’s brand logo and login screen separately to your overall white-labeling settings.
  • Website Templates
    *Hair Salon

  • Extensions
    Import/Export of Modules

    Quickly and easily replicate (or back-up) a complete Custom Module configuration via import/export, including; Settings, Properties, Layouts and Table setup.
  • Website Templates
    Max

  • Extensions
    Website Backup

    Website Backup allows you to create and restore full site backups, including the site database, FTP files and admin configurations, from manual backups as well as a custom automatic schedule.

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.


Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.