SysCP - The ultimate guide
Aders
Florian
eleras@syscp.org
Kaufmann
Michael
mk@syscp-help.org
0.1
2008-02-04
The initial version, nearly nothing inside except the
idea
0.2
2008-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
2008
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.
The admins handbook
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!
The loginscreen
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.
The overview of an admin
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.
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>)")
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.
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.
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.
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.
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.
Details about the SysCP - installation
The users handbook
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!
The loginscreen
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.
The overview of a customer
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).
Account data
Here you can see your
account-related data such as name, address, customer-number,
etc.
Name
Here you can
see the name your admin added you with
Corporation
Here you can
see the corporation-name your admin added you with
Street
Here you can
see the street your admin added you with
ZIP/City
Here you can
see the ZIP-Cide and city your admin added you with
Email address
Here you can
see the email address your admin added you with
Customer-number
Here you
can see the customer-number given by your admin
Ressources
Here you can see
your available and used ressources
Username
This is
your SysCP username, used to login into SysCP and FTP
Domain(s)
These are
your available domains, which have been added to your
account.
Subdomains
This
is the amount of subdomains you have used and available (the amount
of available subdomains is in brackets)
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
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.
E-Mail
There are three different parts, email addreses, email
accounts and email forwarders.
Email addresses
This is
the amount of email addresses you have used and available (the
amount of available email addresses is in brackets)
Email accounts
This
is the amount of email accounts you have used and available (the
amount of available email accounts is in brackets)
Email forwarders
This
is the amount of email forwarders you have used and available (the
amount of available email forwarders is in brackets)
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.
FTP-accounts
This is the
amount of ftp-accounts you have used and available (the amount of
available ftp-accounts is in brackets)
E-Mail management
*** nothing yet ***
The email overview for a customer
Addresses
You can easily manage
your email addresses here, for example: add new addresses, edit
existing addresses and remove unneeded or unused addresses.
The email addresses overview for a customer
New email address
By clicking on
this link, you will be lead to the form for adding a new email
address
Edit email address
By clicking on
this link, you will be lead to the edit-form for the email
address
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.
Webmail
*** nothing yet ***
Support-Tickets
*** nothing yet ***
The ticket overview for a customer
Open new support-ticket
*** nothin yet ***
Subject
*** nothing yet
***
Priority
*** nothing yet
***
Category
*** nothing yet
***
Message
*** nothing yet
***
Reply to support-ticket
*** nothing yet ***
Priority
*** nothing yet
***
Message
*** nothing yet
***
Close support-ticket
*** nothing yet ***
Reopen support-ticket
*** nothing yet
***
MySQL
*** nothing yet ***
Databases
*** nothing yet ***
The mysql overview for a customer
Create a database
*** nothing yet
***
Edit database
*** nothing yet
***
Delete database
*** nothing yet
***
phpMyAdmin
*** nothing yet ***
Domains
*** nothing yet ***
The domain overview for a customer
Add subdomain
*** nothing yet ***
Domain name
*** nothing yet
***
Alias-domain
*** nothing yet
***
OpenBasedir path
*** nothing
yet ***
Edit domain
*** nothing yet ***
Alias
*** nothing yet
***
Wildcard-domain
*** nothing yet
***
OpenBasedir path
*** nothing
yet ***
Delete subdomain
*** nothing yet
***
Usage statistics
*** nothing yet ***
FTP accounts
*** nothing yet ***
The ftp accounts overview for a customer
Add ftp-account
*** nothing yet ***
Password
*** nothing yet
***
Edit ftp-account
*** nothing yet ***
Password
*** nothing yet
***
Delete ftp-account
*** nothing yet ***