Publii Documentation

File: README.md Copy Chapter

Publii - Static CMS for privacy-focused, SEO-optimized websites.

Publii is a desktop-based CMS for Windows, Mac and Linux that makes creating static websites fast
and hassle-free, even for beginners.

Current version: 0.47.9 - build 17481

Why Publii? Copy Chapter

Unlike static-site generators that are often unwieldy and difficult to use, Publii provides an
easy-to-understand UI much like server-based CMSs such as WordPress or Joomla!, where users
can create posts and other site content, and style their site using a variety of built-in themes and
options. Users can enjoy the benefits of a super-fast and secure static website, with all the
convenience that a CMS provides.

What makes Publii even more unique is that the app runs locally on your desktop rather
than on the site's server. Available for Windows, Mac, Linux once the app has been installed
you can create a site in minutes, even without internet access; since Publii is a desktop app you
can create, update and modify your site offline, then upload the site changes to your server at
the click of a button. Publii supports multiple upload options, including standard HTTP/HTTPS
servers, Netlify, Amazon S3, GitHub Pages and Google Cloud or SFTP.

Download Copy Chapter

Publii is available for Mac, Windows, and Linux and can be downloaded from our website:

Download Publii (.exe, .dmg, .deb, .rpm, .AppImage)

Developing Copy Chapter

If you want to build newest version of Publii or contribute to the Publii code, please read about app build process.

Getting Started Copy Chapter

You can learn more about getting started in our User documentation or Developer documentation.
If you have any questions or suggestions, or just need some help with using Publii, you can
visit our Community Hub or follow us on Twitter

Learn More Copy Section

• User docs
• Developer docs
• Wiki
• Issues
• Community forum

Contributors Copy Chapter

This project exists thanks to all the people who contribute.

Backers Copy Chapter

Thank you to all our backers! 🙏 [Become a backer]

Sponsors Copy Chapter

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License Copy Chapter

Copyright (c) 2026 TidyCustoms. General Public License v3.0, read LICENSE for details.

File: app/back-end/modules/custom-changes/ftp/README.md Copy Chapter

Description

node-ftp is an FTP client module for node.js that provides an asynchronous interface for communicating with an FTP server.

Requirements

• node.js -- v0.8.0 or newer

Install

npm install ftp

Examples

• Get a directory listing of the current (remote) working directory:

var Client = require('ftp');

  var c = new Client();
  c.on('ready', function() {
    c.list(function(err, list) {
      if (err) throw err;
      console.dir(list);
      c.end();
    });
  });
  // connect to localhost:21 as anonymous
  c.connect();

• Download remote file 'foo.txt' and save it to the local file system:

var Client = require('ftp');
  var fs = require('fs');

  var c = new Client();
  c.on('ready', function() {
    c.get('foo.txt', function(err, stream) {
      if (err) throw err;
      stream.once('close', function() { c.end(); });
      stream.pipe(fs.createWriteStream('foo.local-copy.txt'));
    });
  });
  // connect to localhost:21 as anonymous
  c.connect();

• Upload local file 'foo.txt' to the server:

var Client = require('ftp');
  var fs = require('fs');

  var c = new Client();
  c.on('ready', function() {
    c.put('foo.txt', 'foo.remote-copy.txt', function(err) {
      if (err) throw err;
      c.end();
    });
  });
  // connect to localhost:21 as anonymous
  c.connect();

API

Events Copy Chapter

• greeting(< string >msg) - Emitted after connection. msg is the text the server sent upon connection.

• ready() - Emitted when connection and authentication were sucessful.

• close(< boolean >hadErr) - Emitted when the connection has fully closed.

• end() - Emitted when the connection has ended.

• error(< Error >err) - Emitted when an error occurs. In case of protocol-level errors, err contains a 'code' property that references the related 3-digit FTP response code.

Methods Copy Chapter

* Note: As with the 'error' event, any error objects passed to callbacks will have a 'code' property for protocol-level errors.

• (constructor)() - Creates and returns a new FTP client instance.

• connect(< object >config) - (void) - Connects to an FTP server. Valid config properties:

  • host - string - The hostname or IP address of the FTP server. Default: 'localhost'

  • port - integer - The port of the FTP server. Default: 21

  • secure - mixed - Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990) Default: false

  • secureOptions - object - Additional options to be passed to tls.connect(). Default: (none)

  • user - string - Username for authentication. Default: 'anonymous'

  • password - string - Password for authentication. Default: 'anonymous@'

  • connTimeout - integer - How long (in milliseconds) to wait for the control connection to be established. Default: 10000

  • pasvTimeout - integer - How long (in milliseconds) to wait for a PASV data connection to be established. Default: 10000

  • keepalive - integer - How often (in milliseconds) to send a 'dummy' (NOOP) command to keep the connection alive. Default: 10000

• end() - (void) - Closes the connection to the server after any/all enqueued commands have been executed.

• destroy() - (void) - Closes the connection to the server immediately.

Required "standard" commands (RFC 959) Copy Section

• list([< string >path, ][< boolean >useCompression, ]< function >callback) - (void) - Retrieves the directory listing of path. path defaults to the current working directory. useCompression defaults to false. callback has 2 parameters: < Error >err, < array >list. list is an array of objects with these properties:

  text Copy

  * type - _string_ - A single character denoting the entry type: 'd' for directory, '-' for file (or 'l' for symlink on **\*NIX only**).
  
  * name - _string_ - The name of the entry.
  
  * size - _string_ - The size of the entry in bytes.
  
  * date - _Date_ - The last modified date of the entry.
  
  * rights - _object_ - The various permissions for this entry **(*NIX only)**.
  
      * user - _string_ - An empty string or any combination of 'r', 'w', 'x'.
  
      * group - _string_ - An empty string or any combination of 'r', 'w', 'x'.
  
      * other - _string_ - An empty string or any combination of 'r', 'w', 'x'.
  
  * owner - _string_ - The user name or ID that this entry belongs to **(*NIX only)**.
  
  * group - _string_ - The group name or ID that this entry belongs to **(*NIX only)**.
  
  * target - _string_ - For symlink entries, this is the symlink's target **(*NIX only)**.
  
  * sticky - _boolean_ - True if the sticky bit is set for this entry **(*NIX only)**.

• get(< string >path, [< boolean >useCompression, ]< function >callback) - (void) - Retrieves a file at path from the server. useCompression defaults to false. callback has 2 parameters: < Error >err, < ReadableStream >fileStream.

• put(< mixed >input, < string >destPath, [< boolean >useCompression, ]< function >callback) - (void) - Sends data to the server to be stored as destPath. input can be a ReadableStream, a Buffer, or a path to a local file. useCompression defaults to false. callback has 1 parameter: < Error >err.

• append(< mixed >input, < string >destPath, [< boolean >useCompression, ]< function >callback) - (void) - Same as put(), except if destPath already exists, it will be appended to instead of overwritten.

• rename(< string >oldPath, < string >newPath, < function >callback) - (void) - Renames oldPath to newPath on the server. callback has 1 parameter: < Error >err.

• logout(< function >callback) - (void) - Logout the user from the server. callback has 1 parameter: < Error >err.

• delete(< string >path, < function >callback) - (void) - Deletes a file, path, on the server. callback has 1 parameter: < Error >err.

• cwd(< string >path, < function >callback) - (void) - Changes the current working directory to path. callback has 2 parameters: < Error >err, < string >currentDir. Note: currentDir is only given if the server replies with the path in the response text.

• abort(< function >callback) - (void) - Aborts the current data transfer (e.g. from get(), put(), or list()). callback has 1 parameter: < Error >err.

• site(< string >command, < function >callback) - (void) - Sends command (e.g. 'CHMOD 755 foo', 'QUOTA') using SITE. callback has 3 parameters: < Error >err, < _string >responseText, < integer >responseCode.

• status(< function >callback) - (void) - Retrieves human-readable information about the server's status. callback has 2 parameters: < Error >err, < string >status.

• ascii(< function >callback) - (void) - Sets the transfer data type to ASCII. callback has 1 parameter: < Error >err.

• binary(< function >callback) - (void) - Sets the transfer data type to binary (default at time of connection). callback has 1 parameter: < Error >err.

Optional "standard" commands (RFC 959) Copy Section

• mkdir(< string >path, [< boolean >recursive, ]< function >callback) - (void) - Creates a new directory, path, on the server. recursive is for enabling a 'mkdir -p' algorithm and defaults to false. callback has 1 parameter: < Error >err.

• rmdir(< string >path, [< boolean >recursive, ]< function >callback) - (void) - Removes a directory, path, on the server. If recursive, this call will delete the contents of the directory if it is not empty. callback has 1 parameter: < Error >err.

• cdup(< function >callback) - (void) - Changes the working directory to the parent of the current directory. callback has 1 parameter: < Error >err.

• pwd(< function >callback) - (void) - Retrieves the current working directory. callback has 2 parameters: < Error >err, < string >cwd.

• system(< function >callback) - (void) - Retrieves the server's operating system. callback has 2 parameters: < Error >err, < string >OS.

• listSafe([< string >path, ][< boolean >useCompression, ]< function >callback) - (void) - Similar to list(), except the directory is temporarily changed to path to retrieve the directory listing. This is useful for servers that do not handle characters like spaces and quotes in directory names well for the LIST command. This function is "optional" because it relies on pwd() being available.

Extended commands (RFC 3659) Copy Section

• size(< string >path, < function >callback) - (void) - Retrieves the size of path. callback has 2 parameters: < Error >err, < integer >numBytes.

• lastMod(< string >path, < function >callback) - (void) - Retrieves the last modified date and time for path. callback has 2 parameters: < Error >err, < Date >lastModified.

• restart(< integer >byteOffset, < function >callback) - (void) - Sets the file byte offset for the next file transfer action (get/put) to byteOffset. callback has 1 parameter: < Error >err.