PLESK SDK

Copyright © 2004 by SWsoft, Inc. All rights reserved.

Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder.

Linux is a registered trademark of Linus Torvalds. RedHat is a registered trademark of Red Hat Software, Inc. All other trademarks and copyrights are the property of their respective owners.

13755 Sunrise Valley Drive, Suite 325, Herndon, VA, 20171 USA, Ph.: +1 (703) 815-5670, Fax.:+1 (703) 815-5675

Table of Contents

1. Introduction
1.1 Overview
1.2 Plesk SDK Structure

2. Plesk Application Vault Manual
2.1 Overview
2.2 What's New?
2.3 Application Vault model
2.3.1 Repository
2.3.1.1 Structure
2.3.1.2 Upload to repository
2.3.1.3 Update in repository
2.3.1.4 Remove from repository
2.3.2 Domain
2.3.2.1 Installation on domain
2.3.2.2 Reconfigure on domain
2.3.2.3 Update on domain
2.3.2.4 Remove from domain
2.4 Application Package Building
2.4.1 Package structure
2.4.1.1 Catalog apps
2.4.1.2 Catalog scripts
2.4.1.3 Catalog forms
2.4.1.3.1 Localization of install process
2.4.1.4 Catalog docs
2.4.1.5 Catalog info
2.4.1.6 Catalog screenshots
2.4.1.7 Catalog uninstall
2.4.2 Making package in RPM format
2.4.3 Making package in SH format
2.4.4 Making package in TAR format
2.4.5 Windows scripts feature
2.5 FAQ

3. Plesk Backup Utilities
3.1 Windows version
3.1.1 Introduction
3.1.2 Backing up the configuration information and the data
3.1.2.1 Full backup
3.1.2.2 Selective backup
3.1.2.3 Scheduled backups
3.1.3 Restoring the backed up configuration information and data
3.1.3.1 Mapping
3.1.3.2 Full data restore
3.1.3.3 Selective restore
3.1.3.4 Restoring client backups
3.1.4 Command Line Backup Utilities
3.1.5 FAQ
3.2 Unix version
3.2.1 Introduction
3.2.2 Backing up the configuration information and the data
3.2.2.1 Redirecting the output
3.2.2.2 Compression options
3.2.2.3 Selective backup
3.2.2.4 Other options
3.2.3 Restoring the backed up configuration information and data
3.2.3.1 Redirecting the input
3.2.3.2 Mapping
3.2.3.3 Selective restore
3.2.3.4 Setting the virtual hosts directory
3.2.3.5 Restoring the certificate
3.2.3.6 Other options
3.2.3.7 Notes on restoring at a non-clean Plesk installation
3.2.3.8 Restoring users' backups
3.2.4 Distributed backup and restore
3.2.4.1 Backing up from the remote computer
3.2.4.2 Restoring from the remote computer
3.2.4.3 Simultaneous backup/restore
3.2.5 Configuration file examples
3.2.5.1 Selective backup files
3.2.5.2 Mapping files
3.2.6 FAQ

4. Plesk Custom Buttons
4.1 Overview
4.2 How it works
4.3 Custom Buttons management
4.3.1 Custom Buttons creation
4.3.2 Edit Custom Buttons
4.3.3 Delete Custom Buttons

5. Plesk Command line interface
5.1. Windows version
5.1.1 Overview
5.1.2 How it works
5.1.3 Utilities
5.1.3.1 Client management
5.1.3.2 Domain management
5.1.3.3 Subdomains
5.1.3.4 Mail system management
5.1.4 FAQ
5.2 Unix version
5.2.1 Overview
5.2.2 How it works
5.2.3 Utilities
5.2.3.1 Client management
5.2.3.1.1 Clients creation and modifications
5.2.3.2 Domain management
5.2.3.2.1 Managing Domains
5.2.3.2.2 Managing Anonymous FTP
5.2.3.2.3 Managing Databases
5.2.3.2.4 Managing DNS
5.2.3.2.5 Managing Domain Users
5.2.3.2.6 Managing Web-Protected Directories
5.2.3.2.7 Managing Subdomains
5.2.3.2.8 Managing SSL Certificates
5.2.3.2.9 Managing Web Users
5.2.3.3 Mail system management
5.2.3.3.1 Managing Mail System
5.2.3.3.2 Managing Mailing Lists
5.2.3.3.3 Managing SpamAssassin
5.2.3.3.4 Autoresponders
5.2.3.4 Server configuration management
5.2.3.4.1 Configuring Server (Initial Configuration)
5.2.3.4.2 Changing Control Panel Appearance
5.2.3.4.3 Managing ColdFusion
5.2.3.4.4 Managing IP Addresses
5.2.3.4.5 Managing Statistics
5.2.4 FAQ

6. Plesk Event manager
6.1 Windows version
6.1.1 Overview
6.1.2 How it works
6.1.3 Events description
6.1.4 Creating event handler
6.1.4.1 Parameters
6.1.4.2 Register handler
6.1.4.3 Example of handler
6.2 Unix version
6.2.1 Overview
6.2.2 How it works
6.2.3 Events description
6.2.4 Creating event handler
6.2.4.1 Parameters
6.2.4.3 Register handler
6.2.4.4.Example of handler

7. Plesk Skin Templates
7.1 Introduction
7.1.1 What Is a Skin?
7.1.2 Areas of the User Interface
7.1.3 Files That Compose a Skin
7.1.4 Structure Of Skin Directory
7.2. Creating a Skin
7.2.1 Creating the Skin Directory
7.2.2 Customizable Properties
7.2.3 Preparing a Skin Package for Uploading to the Control Panel
7.3 Installing a Skin
7.3.1 Installing the Skin RPM Package Using the Command Line
8. Plesk Language Packs
8.1 Overview
8.2 How it works
8.3 Plesk Localization
8.3.1 Locale hierarchy
8.3.2 Translating the locale files
8.3.3 Notes on translation
8.4 Language pack (LP) creation
8.4.1 LP requirements
8.4.2 LP SH Format
8.4.3 LP RPM Format
8.4.4 LP build name
8.5 FAQ

9. Plesk Modules
9.1. Overview
9.2. Implementation
9.2.1 User interface
9.2.2 Module Content
9.2.2.1 PHP Scripts Implementing Module Management
9.2.2.1.1 Help localization features
9.2.2.1.2 Plesk API functions
9.2.2.2 C Utilities Implementing Module Management
9.2.2.3 Additional files
9.2.2.4 Module Files
9.2.2.5 Installation and Uninstallation Scripts
9.2.3 Database Tables
9.3. Updating Module
9.4. Creating RPM Installation Package

10. Plesk RPC API
10.1 Overview
10.2 How it works
10.3 Examples
10.4 Plesk RPC API Protocol
10.4.1 Operations with clients
10.4.2 Operations with domains
10.4.3 Server operations
10.4.4 Operations with DNS
10.4.5 Operations with IP
10.4.6 Operations with events

 

to top