SysCP - The ultimate guide

Florian Aders

Michael Kaufmann

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 2.0 Germany License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/2.0/de/ or send a letter to Creative Commons, 543 Howard Street, 5th Floor, San Francisco, California, 94105, USA.

Revision History
Revision 0.12008-02-04

The initial version, nearly nothing inside except the idea

Revision 0.22008-02-07

d00p (Michael Kaufmann) began the customer-section, EleRas (Florian Aders) finished the overall designing to let this doc work with SysCP and started the admin-section


Table of Contents

1. The admins handbook
1. Login
2. The overview
2.1. The user ressources
2.2. The system details
2.3. Details about the SysCP - installation
2. The users handbook
1. Login
2. The overview
2.1. Account data
2.2. Ressources
3. E-Mail management
3.1. Addresses
3.2. Webmail
4. Support-Tickets
4.1. Open new support-ticket
4.2. Reply to support-ticket
4.3. Close support-ticket
4.4. Reopen support-ticket
5. MySQL
5.1. Databases
5.2. phpMyAdmin
6. Domains
6.1. Add subdomain
6.2. Edit domain
6.3. Delete subdomain
6.4. Usage statistics
7. FTP accounts
7.1. Add ftp-account
7.2. Edit ftp-account
7.3. Delete ftp-account
8. Extras
8.1. Directory protection
8.2. Path options
Index
Glossary

Chapter 1. The admins handbook

1. Login

The login of SysCP is a rather simple form, you just have to choose the language you want to use inside, enter your login-information and click on "Login". If you choose the "language" "Profile language". SysCP will look into your account-settings and show you your desired language. This may be different than the global language of the SysCP - installation. Once you are inside, we'll show you what you are able to do on adminside in SysCP, so keep your breath!

2. The overview

Right after the login you are greeted with the overview over your account, you are able to see some system-configurations and you'll get informations about the status of your SysCP - installation.

On the lefthand side you have the always - present menu, which gives you a quick access to every area of SysCP. But first let's have a look to the big table in the main part of the page. It's divided into three parts: The ressources you have (more on this later), some informations on your system-configuration (mainly software - versions) and some statusinformations of SysCP.

2.1. The user ressources

In the "user-ressources" you are able to see, how many ressources you have (Most time the format is: "<total usage> (<allocated usage> / <your limit>)")

2.1.1. Customers

These values shows how many customers there are currently on the system and how many customers you are able to create (Format: "<total customers> (<your limit>)") . The number of total customers depends on your status. If you are able to see all customers, it's the number of total customers on the system, if you are only allowed to see your customers, the "<total>" - value represents your customer-count.

2.1.2. Domains

These values show you how many domains there are currently on the system and how many domains you are able to create (Format: "<total domains> (<your limit>)") . The number of total domains depends on your status. If you are able to see all domains, it's the number of total domains on the system, if you are only allowed to see your domains, the "<total>" - value represents your domain-count.

2.1.3. Webspace

The webspace - values represent the diskspace used on the system. The first value represent the really used diskspace, the second one shows how much diskspace you already allocated to your customers and the third shows how much diskspace you are able to assign to your customers.

The acutal value is an addition of webspace, mailspace and mysqlspace.

2.1.4. Traffic

The traffic - values represent the traffic used by the customers. The first value represent the already used traffic, the second one displays the traffic you already allocated to your customers and the third shows how much traffic you are allowed to assign to your customers.

2.1.5. MySQL - databases

In the row "MySQL - databases" the usage of MySQL-databases is displayed. In brackets the values represent how many databases you already allocated to your customers and how many you are able to assign in total. The value before the brackets shows the amount of databases, your customers actually use.

2.2. The system details

2.3. Details about the SysCP - installation

Chapter 2. The users handbook

1. Login

The login of SysCP is a rather simple form, you just have to choose the language you want to use inside, enter your login-information and click on "Login". If you choose the "language" "Profile language". SysCP will look into your account-settings and show you your desired language. This may be different than the global language of the SysCP - installation. Once you are inside, we'll show you what you are able to do as a customer in SysCP, so keep your breath!

2. The overview

Right after the login you are greeted with the overview over your account, you are able to see your account releated data such as available and used ressources.

On the lefthand side you have the always - present menu, which gives you a quick access to every area of SysCP. But first let's have a look to the big table in the main part of the page. It's divided into two parts: The account-data and the ressources you have (more on this later).

2.1. Account data

Here you can see your account-related data such as name, address, customer-number, etc.

2.1.1. Name

Here you can see the name your admin added you with

2.1.2. Corporation

Here you can see the corporation-name your admin added you with

2.1.3. Street

Here you can see the street your admin added you with

2.1.4. ZIP/City

Here you can see the ZIP-Cide and city your admin added you with

2.1.5. Email address

Here you can see the email address your admin added you with

2.1.6. Customer-number

Here you can see the customer-number given by your admin

2.2. Ressources

Here you can see your available and used ressources

2.2.1. Username

This is your SysCP username, used to login into SysCP and FTP

2.2.2. Domain(s)

These are your available domains, which have been added to your account.

2.2.3. Subdomains

This is the amount of subdomains you have used and available (the amount of available subdomains is in brackets)

2.2.4. Webspace

The webspace - values represent the diskspace used on the system. The first value represent the used diskspace, the second one shows the total diskspace you have available

2.2.5. Traffic

The traffic - The first value represents the already used traffic, the second one shows how much traffic you are allowed to use per month.

2.2.6. E-Mail

There are three different parts, email addreses, email accounts and email forwarders.

2.2.6.1. Email addresses

This is the amount of email addresses you have used and available (the amount of available email addresses is in brackets)

2.2.6.2. Email accounts

This is the amount of email accounts you have used and available (the amount of available email accounts is in brackets)

2.2.6.3. Email forwarders

This is the amount of email forwarders you have used and available (the amount of available email forwarders is in brackets)

2.2.7. MySQL-databases

In the row "MySQL - databases" the usage of MySQL-databases is displayed. In brackets the value represents how many databases you are able to create in total. The value before the brackets shows the amount of databases, you actually use.

2.2.8. FTP-accounts

This is the amount of ftp-accounts you have used and available (the amount of available ftp-accounts is in brackets)

3. E-Mail management

*** nothing yet ***

3.1. Addresses

You can easily manage your email addresses here, for example: add new addresses, edit existing addresses and remove unneeded or unused addresses.

3.1.1. New email address

By clicking on this link, you will be lead to the form for adding a new email address

3.1.2. Edit email address

By clicking on this link, you will be lead to the edit-form for the email address

3.1.3. Delete email address

By clicking this link, you will be asked to confirm the deletion of the email address. If you confirm, the email address will be removed from the system. This cannot be undone.

3.2. Webmail

*** nothing yet ***

4. Support-Tickets

*** nothing yet ***

4.1. Open new support-ticket

*** nothin yet ***

4.1.1. Subject

*** nothing yet ***

4.1.2. Priority

*** nothing yet ***

4.1.3. Category

*** nothing yet ***

4.1.4. Message

*** nothing yet ***

4.2. Reply to support-ticket

*** nothing yet ***

4.2.1. Priority

*** nothing yet ***

4.2.2. Message

*** nothing yet ***

4.3. Close support-ticket

*** nothing yet ***

4.4. Reopen support-ticket

*** nothing yet ***

5. MySQL

*** nothing yet ***

5.1. Databases

*** nothing yet ***

5.1.1. Create a database

*** nothing yet ***

5.1.2. Edit database

*** nothing yet ***

5.1.3. Delete database

*** nothing yet ***

5.2. phpMyAdmin

*** nothing yet ***

6. Domains

*** nothing yet ***

6.1. Add subdomain

*** nothing yet ***

6.1.1. Domain name

*** nothing yet ***

6.1.2. Alias-domain

*** nothing yet ***

6.1.3. Path

*** nothing yet ***

6.1.4. URL

*** nothing yet ***

6.1.5. OpenBasedir path

*** nothing yet ***

6.2. Edit domain

*** nothing yet ***

6.2.1. Alias

*** nothing yet ***

6.2.2. Path

*** nothing yet ***

6.2.3. URL

*** nothing yet ***

6.2.4. Wildcard-domain

*** nothing yet ***

6.2.5. OpenBasedir path

*** nothing yet ***

6.3. Delete subdomain

*** nothing yet ***

6.4. Usage statistics

*** nothing yet ***

7. FTP accounts

*** nothing yet ***

7.1. Add ftp-account

*** nothing yet ***

7.1.1. Path

*** nothing yet ***

7.1.2. Password

*** nothing yet ***

7.2. Edit ftp-account

*** nothing yet ***

7.2.1. Password

*** nothing yet ***

7.3. Delete ftp-account

*** nothing yet ***

8. Extras

*** nothing yet ***

8.1. Directory protection

*** nothing yet ***

8.1.1. Add directory protection

*** nothing yet ***

8.1.1.1. Path

*** nothing yet ***

8.1.1.2. Username

*** nothing yet ***

8.1.1.3. Password

*** nothing yet ***

8.1.2. Edit directory protection

*** nothing yet ***

8.1.2.1. Password

*** nothing yet ***

8.1.3. Delete directory protection

*** nothing yet ***

8.2. Path options

*** nothing yet ***

8.2.1. Add options

*** nothing yet ***

8.2.1.1. Path

*** nothing yet ***

8.2.1.2. Directory content browsing

*** nothing yet ***

8.2.1.3. URL to error-document 404

*** nothing yet ***

8.2.1.4. URL to error-document 403

*** nothing yet ***

8.2.1.5. URL to error-document 500

*** nothing yet ***

8.2.2. Edit options

*** nothing yet ***

8.2.2.1. Directory content browsing

*** nothing yet ***

8.2.2.2. URL to error-document 404

*** nothing yet ***

8.2.2.3. URL to error-document 403

*** nothing yet ***

8.2.2.4. URL to error-document 500

*** nothing yet ***

8.2.3. Delete options

*** nothing yet ***

Index

Glossary