User Manual Version 17.0 · 7.1.2.5 Setting-up the Autoresponder and Email Filter..... 34. KeyHelp...
Transcript of User Manual Version 17.0 · 7.1.2.5 Setting-up the Autoresponder and Email Filter..... 34. KeyHelp...
User Manual
Version 17.0.0
© Keyweb AG 2017
KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 1
© Keyweb AG 2017
Contents
Content
1. The Current KeyHelp 4
1.1 Explore KeyHelp ........................................................................................................4
1.2 Finding a Fault and Being Stuck with it? .........................................................4
1.3 Who is this Manual for? ...........................................................................................4
2. The Login 5
3. First Orientation in KeyHelp 6
4. Main Navigation Bar 7
5. General 8
5.1 Overview .......................................................................................................................8
5.2 Web Statistics ........................................................................................................... 10
5.2.1 Setting a Password ...................................................................................................10
5.2.2 Accessing the Web Statistics .................................................................................10
6. Settings 12
6.1 Domains ......................................................................................................................12
6.1.1 Editing Domains ........................................................................................................13
6.1.2 Setting-up, Editing and Deleting Subdomains ..............................................15
6.2 MySQL Databases ...................................................................................................17
6.2.1 Setup of a Database with Automatically Generated Database Name and Database Username .......................................................17
6.2.2 Setup of Database with Freely Selectable Database Name and Database Username .......................................................18
KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 2
© Keyweb AG 2017
Contents
6.3 FTP User...................................................................................................................... 19
6.3.1 FTP Security ................................................................................................................19
6.3.2 Main FTP Login ..........................................................................................................19
6.3.3 Additional FTP Users .............................................................................................. 20
6.4 Directory Protection ............................................................................................. 22
6.5 Backup ........................................................................................................................ 23
6.5.1 Overview..................................................................................................................... 23
6.5.2 Local and Remote Repository ............................................................................. 23
6.5.2.1 Creating a Remote Repository Using FTP .............................................................24
6.5.2.2 Creating a Remote Repository Using SFTP ...........................................................24
6.5.3 Create Backup ........................................................................................................... 25
6.5.4 Schedule a Backup ...................................................................................................26
6.5.5 Show Existing Backups ...........................................................................................27
6.5.6 Downloading Backups ............................................................................................27
6.5.7 Deleting Backups ..................................................................................................... 28
6.5.8 Restore Backups ....................................................................................................... 28
6.6 Scheduled Tasks ..................................................................................................... 28
6.6.1 Create Scheduled Tasks ......................................................................................... 28
6.6.2 Instructions for Entering the Command for Scheduled Tasks ................. 30
6.6.3 How to Enter the Timetable in Cron Style ...................................................... 30
7. Email 32
7.1 Email Addresses ...................................................................................................... 32
7.1.1 Setting-up Email Addresses ..................................................................................32
7.1.2 Aliases Addresses, Forwardings, Security Measures and Email Filter ..........................................................................................................33
7.1.2.1 Aliases Addresses ........................................................................................................33
7.1.2.2 Forwardings .................................................................................................................34
7.1.2.3 Virus Scanner ...............................................................................................................34
7.1.2.4 Spam Filter ...................................................................................................................34
7.1.2.5 Setting-up the Autoresponder and Email Filter ..................................................34
KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 3
© Keyweb AG 2017
Contents
7.1.3 Access through Mail-Client (e.g. Outlook, Windows Live-Mail, Thunderbird) ...........................................35
7.1.3.1 Sample Setup for Windows Live Mail ....................................................................36
7.1.3.2 Sample Configuration for Mozilla Thunderbird .................................................36
7.1.3.3 Sample Configuration for Outlook 2013...............................................................37
7.1.3.4 Sample Configuration for Apple iPhone ..............................................................38
7.1.3.5 Sample Configuration for Apple Mail ...................................................................39
7.1.3.6 Notes for users of a Speedport router of Deutsche Telekom AG .....................42
8. Tools 43
8.1 PHPMyAdmin ........................................................................................................... 43
8.2 Webmail ..................................................................................................................... 43
8.2.1 Configuration of Autoresponder and Email Filters (only Roundcube .....................................................................43
9. Help 46
9.1 Manual ........................................................................................................................ 46
10. Additional Navigation Bar 47
11. Appendix - Further Links 49
The Current KeyHelp KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 4
© Keyweb AG 2017
1. The Current KeyHelp
1.1 Explore KeyHelp
Already used on thousands of machines: the popular administration software KeyHelp! Its clear design and modern operating concept awaits to be explored by you. Clarity and a large range of functions are the most appreciated things about KeyHelp. These are the premises that guide us in every further development. A stringent menu and design provide the basis for all users to orient themselves quickly, so that frustrating und long-winded familiarization is no longer required.
So as to make your initial use of the software even easier we have produced this manual. We recommend reading through it carefully. You are quite likely to find an answer in here for most of your questions.
We hope you have fun exploring KeyHelp.
1.2 Finding a Fault and Being Stuck with it?
Not at KeyHelp! Despite all the long and laborious testing we can never completely rule out that the odd flaw creeps in or that a use is obscure.
Should you ever notice anything that is not quite functioning as it should, please let us know about it immediately! Preferably send us an email. Customers of the Keyweb AG can also use the ticketing system. Please don’t be shy – we really appreciate your feedback and suggestions for improvement!
Our developers at KeyHelp continue to work tirelessly on improving and expanding the functionality of the administration tool. Your feedback is of great help.
1.3 Who is this Manual for?
This manual is aimed at domain administrators and explains how to manage your account, how to set up email addresses, add FTP users or access web statistics and use additional functions. If you own your own server and are managing this server through KeyHelp, please read our Administrator Manual first!
The Login KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 5
© Keyweb AG 2017
2. The Login
You only require a standard browser to call up the KeyHelp interface. We have success-fully tested its functionality using all the better known browsers, incl. Internet Explorer, Firefox, Google Chrome and Opera, both in Windows and Linux environments.
Enter either the IP address or the server name in the address bar. You received this information with your welcome email together with your access data.
Enter your user name and password in the respective fields. You can find both in your Welcome email.
First Orientation in KeyHelp KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 6
© Keyweb AG 2017
3. First Orientation in KeyHelp
After successful login you will automatically see the overview page. The main components of the KeyHelp interface are:
1 The main navigation bar on the left – allows you to reach and navigate the various KeyHelp functions.
2 The Display area in the centre. Here you can enter the desired settings for the menu item that you selected from the respective navigation
3 The additional navigation bar at the top – allows you to enter settings concerning your account and to log out.
12
3
Main Navigation Bar KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 7
© Keyweb AG 2017
4. Main Navigation Bar
From the main navigation bar on the left you can reach all functions of KeyHelp. The individual points are explained in the following.
General KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 8
© Keyweb AG 2017
5. General
5.1 Overview
The overview shows you current information about your account.
Diskspace Shows you how much space is currently taken up of your available storage space. Included in the calculation are web data such as PHP and HTML files, but also email mailboxes and databases.
Consumed traffic this month
Shows you the amount of caused traffic during the current month using HTTP, FTP, SMTP, POP3, and IMAP protocols for your account.
Absolute path to your home directory
Shows the complete path of your home directory in the file system of the server.
General KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 9
© Keyweb AG 2017
Main domain(s) Listed here are domains that are assigned to your account(not subdomains!).
Subdomains The existing number of subdomains and the maximum number possible are shown here.
FTP accounts The existing number of FTP accounts and the maximum number possible are shown here.
MySQL databases The existing number of MySQL databases and the maximum number possible are shown here.
Email addresses: He existing number of email addresses and the maximum number possible are shown here. All mailboxes, even aliases, count as email addresses.
Email mailboxes: The existing number of email mailboxes and the maximum number possible are shown here.
Scheduled tasks Die aktuelle und maximal mögliche Anzahl von Geplanten tasks (Cronjobs).
Activated services: The web features that are activated for your account are shown here.
Directory Listing: When the directory listing is active, existing files of a web folder are displayed as file list in the Browser even without an existing (e.g. index.html, index.php).
If the option is deactivated, an error message appears. Change the setting by clicking on the relevant button.
Email address for automatic server notifications: His address is used to send you notifications to warn you when you are about to run out of disk storage space on your account, or to send you administrator information. In addition, should you forget your password you can reset it via this email.
Please note that you need to remember the email address that you entered here in order to be able to use the forgot-your-password function!
General KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 10
© Keyweb AG 2017
5.2 Web Statistics
The web statistics give you information about the visits to your websites, visitor distribution over a certain period of time, where your visitors came from, visitors’ country of origin, the browsers they used and much more.At Keyweb we use the well-known and popular statistics tool AWStats.
5.2.1 Setting a Password
When first accessing this page you are asked to set a password for your access:
Fill in the displayed form with a password of your choice or let it generate automatically.
You can change the password at any time later via this form.
5.2.2 Accessing the Web Statistics
First, choose the time period for which you wish to check the statistics. Then click the button.
A new browser window / tab opens.
General KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 11
© Keyweb AG 2017
Enter the same user name that you use for logging in to KeyHelp (see the access data email) in the login window displayed and enter the password that you have just set (see item 5.2.1).
If login was successful you will then see the statistics page of .
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 12
© Keyweb AG 2017
6. Settings
6.1 Domains
Here you are able to manage your domains and set-up subdomains. One click on the domain name and the domain opens up in a new browser window.
The symbols have the following meaning or function:
The domain is currently configured on the server. It is not yet in running order.
The domain has been configured correctly in the system and is ready for operation.
There was an error processing the domain.
Edit the domain, for example setting up a redirect, or changing a directory.
Ziel Displays the directory assigned to the domain. When the redirect is activated, the URL of the the forwarding destination is disolayed as well as the forwarding code.
Security The domain has been protected with an SSL certi-ficate. The name of the assigned certificate is shown
when the mouse is moved over the padlock icon.
The backup via a Let‘s Encrypt certificate Is activated.
Signalizes that the automatic forwarding to the SSL-secured access to the domain is
active.
HTTP Strict Transport Security, which commands browsers to only access the domain via a secured
connection, was activated.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 13
© Keyweb AG 2017
6.1.1 Editing Domains
Domain Settings:
In order to edit a domain click on the editing symbol behind the respective domain name in the column “Options“.
Your domain name with and without the prefix www are treated separately. For example, you can specify that when your domain is called up without www a different content is shown to the visitor than when it is called up with the www prefix.
You can enter the desired directory below the www folder. If this folder does not exist it will be created from scratch. “/represents your www-directory“. If you want to display the domain in the folder demo for example, you enter /demo/.
You can also forward your domain to an external destination. Specify this by entering http://destinationdomain or https://destinationdomain. The URL changes in the address bar of the browser when the forward-domain is called up.
Select the kind of forwarding and click .
Determine by use of the radio-button which forwarding code shall be used. You can choose from 301 (moved permanently) and 302 (moved temporarily). To select an existing sub directory of the www-folder as the destination for the domain, click the button “Open Directory Explorer”.
Select the desired directory from the newly shown directory explorer and click the button “Take as domain target directory”.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 14
© Keyweb AG 2017
CGI Settings
Note: This menu appears only if the administrator has granted you the corres-ponding rights!
In order to run your CGI programs, you have to tell the web server with the so-called ScriptAlias directive, in which folder they are situated.Use the radio button to select the desired setting.
The default setting provides that the scripts have to be inside the cgi-bin folder of your target directory, e.g. www/cgi-bin/.
With the „Custom setting“ you are also able to set an arbitrary folder below the www directory. The „/“ represents your www directory.
The script alias directory will not be created automatically.
Security:
Note: This menu appears only if the administrator has granted you the corres-ponding rights!
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 15
© Keyweb AG 2017
SSL Certificate: No Certificate: The subdomain is only accessible via an unsecured http connection. Let‘s-Encrypt Certificate: A free certificate from the Let‘s Encrypt Certification Authority is used for the subomain. Exhibition, installation and extension are carried out automatically. Existing Certificate: Existing certificate: From the drop-down menu, select the SSL certificate you want to use to secure the subdomain.
Force secure connection Select whether to automatically redirect all calls to the domain via http:// to https://. (Can only be activated, if an SSL certificate has been selected).
HTTP Strict Transport Security (HSTS)
Enable this option to inform the browser of the domain visitor to use encrypted connections for this subdomain hereafter for a defined time (max-age). (Can only be acti-vated, if an SSL certificate has been selected.) In the Max-Age field, specify how long the browsers should store this information. Typical values are a half (15768000 seconds) or a whole year (31536000 seconds). You can also specify the time in minutes, hours, or days. Select the desired unit from the drop-down menu.
Transfer security options to subdomains
Select wether the settings you have set should also be applied to subdomains. You can select all subdomains or individual ones via SHIFT or CTRL + click.
Then click the button to complete the creation.
6.1.2 Setting-up, Editing and Deleting Subdomains
Click this button to set up a new subdomain .
Domain Settings:
Type the name of the subdomain in the box domain name and select the required domain from the drop-down menu, for which the subdomain has to be created. The target settings follow the settings of the main domains. (see item 6.1.1)
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 16
© Keyweb AG 2017
CGI Settings
Note: This menu appears only if the administrator has granted you the corres-ponding rights!
The settings follow the settings of the main domains (see item 6.1.1). You can later call up this menu, with clicking on the editing symbol of the subdomain.
Security:
Note: This menu appears only if the administrator has granted you the corres-ponding rights!
Activate the checkbox to manage the security options after the creation o the domain. You can also display this menu later using the pencil icon for editing a subdomain. The settings are made analogical to the ones of the main domains. (see item 6.1.1)
The created subdomain now shows up in the overview.
The symbols shown have the following meaning or function:
The subdomain is currently configured on the server. It is not yet in running order.
The subdomain has been configured correctly in the system and is ready for operation.
Here, you can set the target directories and configure forwarding equivalent to point 6.1.1.
Deleting the subdomain. Before deletion there will be a security query first. The assigned directory is NOT deleted.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 17
© Keyweb AG 2017
Ziel Displays the directory assigned to the domain. When the redirect is activated, the URL of the the forwarding destination is disolayed as well as the forwarding code.
Security The domain has been protected with an SSL certi-ficate. The name of the assigned certificate is shown
when the mouse is moved over the padlock icon.
The backup via a Let‘s Encrypt certificate Is activated.
Signalizes that the automatic forwarding to the SSL-secured access to the domain is
active.
HTTP Strict Transport Security, which commands browsers to only access the domain via a secured
connection, was activated.
6.2 MySQL Databases
Click the button ˝Add database˝ to set up a database .
6.2.1 Setup of a Database with Automatically Generated Database Name and Database Username
Enter the password of your choice twice or have one generated automatically.You may enter information in the comment box that may later be helpful in assigning the database to a certain project.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 18
© Keyweb AG 2017
6.2.2 Setup of Database with Freely Selectable Database Name and Database Username
Hint: This feature is only available when it was activated by the KeyHelp administrator.
→ Fill in the respective form fields with the desired values for database name and database username.
→ Enter the password of your choice twice or have one generated automatically.
→ You may enter information in the comment box that may later be helpful in assigning the database to a certain project.
To finish the set-up click .
The database is then displayed with the generated or the selected database name, database user name, as well as the host, the specified description text and the database size.
By using these data you can log in to PHPMyAdmin (see item 8.1).
The symbols shown have the following meaning or function:
To edit your description or to change the password click the pencil symbol.
Delete the database.
Deletes all selected databases.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 19
© Keyweb AG 2017
6.3 FTP User
6.3.1 FTP Security
FTP data is usually transmitted unencrypted. A potential hacker can therefore quite easily get hold of your data and can also obtain your password. For this reason we recommend using FTP via SSL (FTPS) in explicit mode.
You find the settings in your FTP client. In the popular FTP client, Filezilla, you are for instance able to view the settings in the server manager (Image 1).
Image 1: Server manger Filezilla
Note: DON‘T mistake FTPS for SFTP. SFTP has nothing to do with FTP, but is provided by the SSH Server. To be eligible to use SFTP an SSH access is needed, which may not be included in your tariff.
6.3.2 Main FTP Login
To connect to your account via FTP use the same data you received per email and which you also used to log in to KeyHelp.
During the first login you will see the following standard file structure:
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 20
© Keyweb AG 2017
Folders for carrying out CGI and Perl scripts.
Storage for files that shall not be accessible through http
Contain access logs and error logs for your websites.
Folders for scripts set up to be temporary files..Folder for files that shall be accessible via http and https
You can add a random number of folders and subfolders and update access rights. You should NOT delete the standard folders!
Note: Avoid setting the access right to 777, especially within the www directory.It poses a security risk! It is not necessary for operating websites, as PHP runs under your respective User-ID and is thus able to write without causing any problem in folders that you have created through FTP.
6.3.3 Additional FTP Users
To add an additional FTP user click the button .
If required, enter more information e.g for better differentiation for FTP user in the commentary section/field.
You are now able to select the home directory of the user. Either you directly state the desired directory that is automatically generated, or you select an existing directory.
To do this click the button “Open folder explorer”.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 21
© Keyweb AG 2017
Select the desired directory from the newly shown directory explorer and click the button “Take as home directory”.
.
Notes: 1. Users are “locked” in their assigned directory. It means that they can move around within their directory, but cannot access any directories at a higher level. 2. The Home Directory has to be located below the folder www or below files.
Then select a password or have one generated by the system and
click the button .
Following this the FTP user is shown with the user name that has been generated.
The symbols shown have the following meaning or function:
The FTP user is being setup on the system at this moment and is not yet operational
The FTP user was successfully set-up on the system and is now operational.
Changing the home directory or password.
Delete the FTP user. You will see a security prompt which also allows you to specify whether the assigned home directory should be deleted as well.
Deletes all selected FTP users.
You will see a security prompt which also allows you to specify whether the assigned home directory should be deleted as well.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 22
© Keyweb AG 2017
6.4 Directory Protection
Via directory protection you can set up a username-password-combination to your www-directory or its subdirectories. Only after correctly entering this combination, the corresponding content is displayed in the browser.
To set up a directory protection, press the button .
Directory: Specify the directory for which you want to set up a protec-tion. Either directly enter the desired directory, which is created automatically, or select an existing directory. Just click on “Open folder explorer“.
Select the desired directory in the now displayed explorer and click on the button “Take as home directory“.
The directory “/“ is your www-directory on the server. The directory “/example folder/“ is a subfolder of your “www-directory“.
Username: Set any desired username.
Password: Set a password or get a generated one.
Title of the protected area (optional): Enter a name for the protected area, e.g. internal or
development. This will be displayed in the login window of the browser.
Click on the button to apply your settings .
Notices:You can also create multiple users for one directory. To do so, add another directory protection and choose from the same folder, but assign a different username. The access protection is controlled by the configuration file of the domain on the web server. Therefore .htaccess or .htpasswd. are not created in the respective directory.
After creating it, the directory protection is indicated in the overview along with the protected directory, the selected user name and the title of the protected area.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 23
© Keyweb AG 2017
The symbols have the following meaning or function:
The directory protection is being created in the system and is not yet ready for use.
The directory protection was successfully created in the system and can now be used.
Changing the title or the password.
Remove directory protection. A confirmation request occurs.
Deletes all selected entries of the directory protection.
6.5 Backup
Backups are a primary ingredient of data security. We strongly advise you to make regular backups of your data! A potentially existent RAID-system in your server does not replace a backup, because it can only protect from data loss on the hardware side.The accidentally deleted file or data base however is irretrievably lost without an existing backup.
6.5.1 Overview
Via the overview/survey page you can access all backup-functions. Furthermore, you can see the last 5 executed backup tasks sorted by date, status, storage destination and start type.
6.5.2 Local and Remote Repository
Local repository
In the local repository a directory in the server‘s file system serves as filed location for backup data.
Please note: You can only use the local repository if it was seperately activated by the administrator.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 24
© Keyweb AG 2017
Remote repository
Using the remote repository, a different server will be the filed location for backups. KeyHelp supports the connection via FTP and SFTP. Before you can use a remote repo-sitory you have to define it in KeyHelp as follows:
6.5.2.1 Creating a Remote Repository Using FTP
Click on the button .
Fill in the formular accordingly:
Remote server: Enter IP address or host name of the FTP server.
Port: Enter the port on which the FTP server is configured. It is 21 by default. If this field is left empty, the respective default port is used.
Protocol: Select FTP in the drop down menu.
Use FTPS: Activate this checkboy if you want to use encrypted FTP. Please note: The destination server has to be able to support this.
Use passive mode: Activate this checkbox if because of Firewall settings no active FTP can be used.
Directory on the server: Name the directory you want to save backups in, e.g. /myBackups. The named directory has to be existent. If you leave this field empty, the main directory of the FTP user is used.
Login: Enter the FTP user name.
Password: Enter the password of the FTP user.
Test connection: Click on the button to test effected settings.
6.5.2.2 Creating a Remote Repository Using SFTP
Click on the button .
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 25
© Keyweb AG 2017
Fill in the formular accordingly:
Remote server: Enter IP address or host name of the SFTP server.
Port: Enter the port on which the SFTP server is configured. It is 22 by default. If this field is left empty, the respective default port is used.
Protocol: Select SFTP in the drop down menu.
Use public/private key authentification:
Activate this checkbox if you want to use a login via key pair instead of a passwordauthentification.
Directory on the server: Name the directory you want to save backups in, e.g. /myBackups. The named directory has to be existent. If you leave this field empty, the main directory of the SFTP user is used.
Login: Enter the SFTP user name.
Password: Enter the password of the SFTP user. Please note: this option is not shown if you have activated authentification via key pair.
Public key: Click on the button to create a key pair. Then copy the displayed public key into the file autho-rized_keys which is located in the subdirectory .ssh of the homedirectory /main directory of the SFTP user. Please note: This option is only shown if you activated public/private key authentification.
Test connection: Click on the button to test effected settings.
To save your settings, click on afterwards.
6.5.3 Create Backup
To start a backup process, click on the button .
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 26
© Keyweb AG 2017
Fill in the displayed formular accordingly:
Backup content: Displays the contents that are secured by the backup.
Destination repository: Choose the repository onto which the backup is to be secured. Please note: To be able to use a remote repository, you have to create it first (see point 6.5.2.1. and 6.5.2.2.). Using a local repository is only possible if it was activated by an administrator.
Email address for notifications:
Enter an email address to which you want error -notifi-cations to be sent to. If you want to be notified in case of success, tick the respective checkbox.
Password protection: For safety reason we advise to protect your backup with a password, especially if it contains sensitive data. Please keep in mind that you cannot restore the backup without the password! Enter the password or generate a new one.
To save your settings, click on afterwards.
6.5.4 Schedule a Backup
To have KeyHelp perform backups regularly and automatically,
click on the button .
Fill in the displayed formular accordingly:
This backup task is activated:
Activate this checkbox to enable the planned backup.
Start backup at this time: Enter the desired starting time in the format HH:mm
Backup interval: Choose from the drop down menu the desired interval for the execution of the backup.
Backup content: Displays the contents that are secured by the backup.
Destination repository: Choose the repository onto which the backup is to be secured.Please note: To be able to use a remote repository, you have to create it first (see point 6.5.2.1. and 6.5.2.2.). Using a local repository is only possible if it was activated by an administrator.
Maximal number of data in the repository:
Enter the maximal amount of backup data that you want to be safed in the repository. If the limit is reached, the oldest backup will be deleted to make room for the new
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 27
© Keyweb AG 2017
one. Value 0 or no entry means no limit. Please note that this can lead to complete occupancy of the hard drive space. The administrator can specify a limit. It will be shown underneath.
Email address for notifications:
Enter an e-mail address to which you want error -notifi-cations to be sent to. If you want to be notified in case of success, tick the respective checkbox.
Password protection: For safety reason we advise to protect your backup with a password, especially if it contains sensitive data. Please keep in mind that you cannot restore the backup without the password! Enter the password or generate a new one.
To apply your settings, click on afterwards.
6.5.5 Show Existing Backups
Click on either or to display the the backups in the respective repositories. They are listed with date of creation, file name and size.
To change view to the other repository, you can use the drop down menu atop the file list.
6.5.6 Downloading Backups
Click on , to display the backups located in the local repository.
Click on the button , behind the respective file name of the backup to download it.
Downloading backups is only possible from the local repository!
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 28
© Keyweb AG 2017
6.5.7 Deleting Backups
Click on either or ,to display the the backups in the respective repositories.
Activate the checkbox behind the backups which you want to delete.
Click on the button .
6.5.8 Restore Backups
An automatic recovery of backups is currently not possible. It has to be effected manually. Please contact the support for questions.
6.6 Scheduled Tasks
Note: This menu item is only available when it was activated by the KeyHelp administrator!
With the help of scheduled tasks, so called cronjobs, you can operate certain com-mands or scripts automated at a particular time or in a specific interval.
6.6.1 Create Scheduled Tasks
Click the button .
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 29
© Keyweb AG 2017
Complete the displayed form as shown:
Is enabled? Mark the checkbox to perform the scheduled task.
Command Specify the command or script that should be executed. Please observe the notes under point 6.6.2.
Description For a better differentiation of the cron jobs, enter a description..
Schadule Select the desired interval from the drop-down menu respectively the input mode.
Hourly: Specify the minute when to start the execution.
Every day: Specify the time of day when the execution should start.
Weekly: Enter the day of the week and the time when The execution should start.
Monthly: Specify the day of the month and the time to start the execution.
Yearly: Specify the date and time to start the execution.
Cron style: Specify the desired execution in cron style (see item 6.6.2).
Email for notification
Geben Sie eine E-Mail-Adresse an, an die der Cron-Dienst Nachrichten über Die Ausführung oder Fehlermeldungen senden soll.
In order to transfer your settings, click on .
The scheduled task is then displayed in the overview.
The symbols and fields have the following meaning or function:
The scheduled task is activated.
The scheduled task is not activated.
Command Displays the lodged command.
Schedule Displays the set execution time.
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 30
© Keyweb AG 2017
Change the settings for the scheduled task.
Delete scheduled task. There is a security check.
Deletes all selected scheduled tasks.
A security check appears.
6.6.2 Instructions for Entering the Command for Scheduled Tasks
Always specify the complete path to the script ought to be run, e.g. /home/users/myuser/files/myscript.sh.
If possible, always give system commands with the complete path, e.g /usr/bin/rsync instead of just rsync.
PHP files can usually not be executed directly but must opened using PHP‘s command line interpreters (PHP-CLI), or by other system programs.
→ Execution via PHP-CLI /usr/bin/php –f /path/to/PHP-script/cron.php
→ Execution via textbrowser lynx (possibly this has to be installed on the server beforehand) /usr/bin/lynx –dump http://URL/to/PHP-script/cron.php
→ Execution using wget /usr/bin/wget –q –O /dev/zero http://URL/to/PHP-script/cron-php
6.6.3 How to Enter the Timetable in Cron Style
In the cron style, the execution time is determined by 5 parameters which are sepa-rated by space or tab.
* * * * *Weekday (0-7, Sunday is 0 and 7)Month1-12)Day of the month (1-31)Hour (0-23)Minute (0-59)
Settings KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 31
© Keyweb AG 2017
Beispiele:
* * * * * Every minute
0 0 * * * Daily at midnight
5 * * * * Five minutes after each full hour
*/15 * * * * Every 15 minutes
0 * 15 * * On the 15th day of the month at full hours
15 20 * * 6 Every Saturday at 8:15 pm o‘clock
20,30 1 * * 1-5 1-5 Monday to Friday at 01:20 and 1:30 am o‘clock
For simplification, the five parameters can also be replaced by a single string.
Therefore, eight keywords are defined:
String Meaning Cron-Style
@reboot once at system start
@daily once a day 0 0 * * *
@midnight once a day 0 0 * * *
@hourly once per hour 0 * * * *
@weekly once a week 0 0 * * 0
@monthly once a month 0 0 1 * *
@annually once a year 0 0 1 1 *
@yearly once a year 0 0 1 1 *
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 32
© Keyweb AG 2017
7. Email
7.1 Email Addresses
7.1.1 Setting-up Email Addresses
To set up a new email address click the button .
Enter the desired mailbox name in the form field Email and select the domain for which the mailbox is to be set up.
Create a password of your choice or opt to have one generated automatically.
Activate the check box „Activate catch-all“ if you wish to receive all messages on this account, that are sent to non-existent email addresses of the domain. Please note the information displayed in the form!
Determine the size of the mailbox.Activate the control box “After setting up the email account call up the page for managing aliases addresses, forwarding and security measures”, if you want to execute more settings immediately.
Click the button .
The Email account is then shown with the user name that was generated, the current memory usage and any forwarding’s and security measures implemented.
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 33
© Keyweb AG 2017
The symbols shown have the following meaning or function:
The Email account is being set-up on the system at this moment and is not yet operational.
The Email account was successfully set up on the system and is now operational.
Forwarding: Displays active forwardings for the mail account.
Username: Displays the user name of the mailbox
Mailbox size: Displays the current size mailboxes.
Catch-All?: Indicates whether the mailbox is a catch-all mailbox.
Protection: The virus scanner is enabled The spam scanner is enabled
Changing the password, the size of the mailbox, the aliases addresses, and the forwarding’s and security measures.
Deleting the Email account.
Opens the webmailer in a new tab. The user name will be passed to the login form. (Only visible when Roundcube is the enabled webmailer).
Deletes all selected Email accounts.
7.1.2 Aliases Addresses, Forwardings, Security Measures and Email Filter
7.1.2.1 Aliases Addresses
Aliases addresses are Email addresses which are assigned to a main mailbox which receives the emails sent to these addresses.
Enter the desired alias in the form field and click the button .
To delete an alias click the button behind the respective alias.
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 34
© Keyweb AG 2017
7.1.2.2 Forwardings
To forward emails that are sent to the configured email address enter the desired destination address in the form field “Forward to”. You may specify several destination addresses separated by a space, a comma, a semicolon or a line break.
If a copy of the forwarded emails is to be saved on the server, please put a tick in the corresponding control box.
7.1.2.3 Virus Scanner
Activate the virus scanner to scan incoming emails for harmful files before they reach the inbox. Such harmful emails are identified in the subject field with the word “Infected”.
7.1.2.4 Spam Filter
Activate the Spam Filter to scan incoming emails for signs of being spam mail before they can reach the inbox. Such harmful emails are identified in the subject field with the word “Spam”.You can regulate the spam filter sensitivity via the Spam-Score field; the lower the number the higher the spam filter’s sensitivity.
Click to accept the changes to the forwarding settings or to the email security settings.
7.1.2.5 Setting-up the Autoresponder and Email Filter
You can configure the autoresponder and email filter on the webmail interface. (see item 8.2.1)
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 35
© Keyweb AG 2017
7.1.3 Access through Mail-Client (e.g. Outlook, Windows Live-Mail, Thunderbird)
Use the following information to set up a mailbox in a mail client:
Username: The complete email address, e.g. [email protected]
Password: The password that you specified when setting up the email address
SMTP-Server: mail.<yourdomain> e.g. mail.keyhelpdemo.de Alternatively, you may also use the IP address. If you are using the web hosting tariff of Keyweb AG, you are advised to use that server name, where your domains are situated to avoid certificate warnings, for example: shared01.keymachine.de, shared02.keymachine.de etc.
POP3/IMAP-Server: mail.<yourdomain> e.g. mail.keyhelpdemo.de Alternatively, you may also use the IP address If you are using the web hosting tariff of Keyweb AG, you are advised to use that server name, where your domains are situated to avoid certificate warnings, for example: shared01.keymachine.de, shared02.keymachine.de etc.
Ports (with/without STARTTLS): IMAP 143, POP3 110, SMTP 25 or 587
Ports (whith SSL): IMAPs 993, POP3s 995,
Notes: Important is that authentification is activated at the outgoing mail server!Sending an email is only possible when STARTTLS is activated! When the respective warning is shown accept the certificate!
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 36
© Keyweb AG 2017
7.1.3.1 Sample Setup for Windows Live Mail
7.1.3.2 Sample Configuration for Mozilla Thunderbird
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 37
© Keyweb AG 2017
7.1.3.3 Sample Configuration for Outlook 2013
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 38
© Keyweb AG 2017
7.1.3.4 Sample Configuration for Apple iPhone
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 39
© Keyweb AG 2017
7.1.3.5 Sample Configuration for Apple Mail
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 40
© Keyweb AG 2017
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 41
© Keyweb AG 2017
Email KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 42
© Keyweb AG 2017
7.1.3.6 Notes for users of a Speedport router of Deutsche Telekom AG
The Telekom uses in the speedport routers of the current generation a feature called „List of secure email servers“. This enables the router connections on port 25 and port 587 only to servers, which are in this list. By default, this list contains only the servers of large mail service providers, so you can‘t establish a connection to your KeyHelp server for sending emails.
To resolve this issue, you must either disable this feature in your router management or add the used mailserver to the list.
1. Log in to the router management. By default it is reachable by the address speedport.ip.
2. Click „Internet“ in the upper menu.
3. In the left menu, click „List of secure e-mail servers“.
4. Disable the feature or add your mail server, e.g. mail.mydomain.com / sharedXX.keymachine.de to the list .
Tools KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 43
© Keyweb AG 2017
8. Tools
8.1 PHPMyAdmin
Note: This menu item is only available when it was activated by the KeyHelp administrator!
PHPMyAdmin is a PHP application for the administration of MySQL databases. Upon clicking the respective menu item the PHPMyAdmin opens in a new browser window/tab.
To log in use the data that was entered when the database was set up.
To directly access PHPMyAdmin you may also use the addresshttps://<SERVERNAME>/phpmyadmin/
8.2 Webmail
Note: This menu item is only available when it was activated by the KeyHelp administrator!
The webmailer is used to read and send email from a mailbox via a web browser. Upon clicking the respective menu item the webmailer opens in a new browser window/tab.
To log in use the data that were entered when the mailbox that you want to access was set up.
To directly access the webmailer you may also use the addresshttps://<SERVERNAME>/webmail/
With Roundcube (https://roundcube.net/) and Rainloop (https://www.rainloop.net/) there are two webmail interfaces on the server, which can be enabled by the KeyHelp administrator.
8.2.1 Configuration of Autoresponder and Email Filters (only Roundcube
Log in to the webmail interface as described under point 8.2. In the top right-hand corner click the button “Settings”.
Tools KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 44
© Keyweb AG 2017
From the left-hand menu called “Settings” select the option “Filter”.
From the central menu “Filter Settings” select the filter option “Standard“.
Via this button you may set up an additional filter setting.
Via the button you can configure the elected filter setting.
In the right “Filter” menu click on the , button to add another filter.
In the section filter definition you are now able to set up the desired filter.
Finally, click to activate the filter.
In the section filter definition you are now able to set up the desired filter.For an autoresponder the configuration would look as shown in the above image. In anactivated autoresponder incoming emails are also saved in the inbox.
Tools KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 45
© Keyweb AG 2017
In this manner you are naturally able to specify any number of filters and you can, for example, move emails with certain subject lines or from certain senders in a folder set up for this, can forward or copy emails, and send them to an additional address, etc.
Example of use: Automatically move spam to the junk folder
Thus mails, which were marked accordingly as junk by junk filter, not delivered to the Inbox, but are automatically moved to the junk folder, you can use the following filter settings:
Note: The Spam folder is only visible when using IMAP!
Help KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 46
© Keyweb AG 2017
9. Help
9.1 Manual
Gives you easy access to the user manual.
Also visit https://www.keyhelp.de/documentation/#tutorials where you the key KeyHelp features are explained in video tutorials.
Additional Navigation Bar KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 47
© Keyweb AG 2017
10. Additional Navigation Bar
The additional navigation bar shows you with which user you are currently logged in to KeyHelp. Furthermore you have access to the following functions:
Changing of language, password and email-address:
Click on your user name to open the form for changing the desired settings:
Additional Navigation Bar KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 48
© Keyweb AG 2017
→ Select from the drop-down menu the desired language for the KeyHelp surface.
→ For altering the password, enter your current password once and the new password twice or to generate this.
→ Enter an email address to receive automatic server messages and to use the „Password forgotten“ function.
To apply the settings click the button .
Log out
Ends your current KeyHelp session.
Appendix - Further Links KeyHelp® User - Manual
KH Version 17.0.0 | last revised: Apr-24 2017 49
© Keyweb AG 2017
11. Appendix - Further Links
Latest informations and more possibilities of support you find here: www.keyhelp.de/en
→ Video-Tutorials https://www.keyhelp.de/documentation/#tutorials
→ Forum https://community.keyhelp.de/
Brands & Names: All brands and product names mentioned on this manual and which may be pro-tected and subject to third party trademark rights are without limitations subject to the respectively valid trademark regulations and the ownership rights of the respective registered owner.
© Keyweb AG 2017
Keyweb AG Neuwerkstraße 45/46 99084 Erfurt Tel.: +49(0)361/65853-0 Fax: +49(0)361/65853-88 [email protected] www.keyweb.de
WWW.KEYHELP.DE