Change Log

  • 02-Nov-2023 | v6.9.1 | Change to FTP host and username format in preparation for v6.10
  • 31-Aug-2023 | v6.9.1 | Change to FTP username format in preparation for v6.10
  • 19-Aug-2022 | v6.7.0 | Added FTP file naming best practises
  • Updated FTP details following change in username pattern

Contributors:

Adam Wilson - Logo Pogo

FTP access format

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

1

Requirements

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

  • Live or trial website on WebinOne
  • FTP Client

Credentials

All WebinOne 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].webinone.com|[reseller/admin-email-address]
to: [sitename].webinone.com@[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].webinone.com
or
[sitename].trialsite.co
Username:
[sitename].webinone.com|[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 WebinOne Portal, under the FTP tab.

Replace [text in the brackets] with the relevant sitename/domain name (as shown in your WebinOne 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 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 has certain directories/folders within a sites file structure which are utilised for system functionality (indicated below by the 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
  • Content
    • 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