Version 1.3 of the ISPConfig 3 Manual is finally available!

Discussion in 'General' started by falko, Oct 7, 2010.

  1. falko

    falko Super Moderator ISPConfig Developer

    Version 1.3 of the ISPConfig 3 Manual is finally available (in PDF format)!

    On more than 300 pages, it covers the concept behind ISPConfig (admin, resellers, clients), explains how to install and update ISPConfig 3, includes a reference for all forms and form fields in ISPConfig together with examples of valid inputs, and provides tutorials for the most common tasks in ISPConfig 3. It also lines out how to make your server more secure and comes with a troubleshooting section at the end.

    Version 1.3 for ISPConfig 3.0.4 (Date: 10/25/2011)
    Author: Falko Timme <[email protected]>
    333 pages

    The manual can be downloaded from these two links:


    * Added documentation for nginx.
    * Added documentation for the virtualization module.
    * Added documentation for Mailman mailing lists.
    * Added documentation for folder protection (basic http authentication).
    * Added documentation for accessing SquirrelMail and phpMyAdmin.
    * Added various new fields to the reference.
    * Updated screenshots and added new screenshots.

    Now the bad news: we can’t offer it for free. But it will be available for as low as 5 EUR per copy – we think this price is more than fair for a manual with more than 300 pages.

    Why Do We Charge For The ISPConfig 3 Manual?

    We hope that this will allow us to employ an additional full-time ISPConfig developer who can disburden the core team. This would accelerate ISPConfig development a lot and also allow us to provide more support for ISPConfig users.

    Will ISPConfig 3 Continue To be Free?


    What Does the ISPConfig 3 Manual Cost?

    You can download it either through an active HowtoForge subscription, or you can buy a single copy.

    Downloading through a HowtoForge subscription has the advantage that you get updates of the manual for free as long as you are a subscriber, while if you buy a single copy, no updates are included (i.e., you would have to pay again for new versions of the manual).

    A HowtoForge subscription costs 5 EUR for one month or 25 EUR for six months.

    If you want to download a single copy of the ISPConfig 3 manual, this costs you 5 EUR which is equal to buying a one-month HowtoForge subscription.

    Copyright Information

    The ISPConfig 3 manual is protected by copyright. No part of the manual may be reproduced, adapted, translated, or made available to a third party in any form by any process (electronic or otherwise) without the written specific consent of projektfarm GmbH. You may keep backup copies of the manual in digital or printed form for your personal use. All rights reserved.

    This means it is not allowed to redistribute the ISPConfig 3 manual in any form (for example by offering it as a download on your web site). Your copy of the ISPConfig 3 manual will be personalized with your real name (or HowtoForge username) and email address.

    If you are an ISP and need multiple copies (e.g. for your clients), please contact us ([email protected]), and we will find a solution.

    Table Of Contents

    1 Conventions Used In This Manual
    1.1 Commands
    1.2 Contents Of Files
    1.3 File Names, Protocol Names, System Specifications, Technical Specifications, User Names, Etc.
    1.4 Highlighting

    2 ISPConfig Users – Admin, Resellers, And Clients
    2.1 Summary
    2.1.1 admin
    2.1.2 Resellers
    2.1.3 Clients

    3 Installation & Updating
    3.1 Single Server Setup
    3.1.1 Nginx/PHP-FPM/CGI
    3.1.2 Mailman
    3.1.3 ISPConfig 3 Installation
    3.2 Multiserver Setup
    3.2.1 Installing A Multiserver Setup With Dedicated Web, Email, DNS And MySQL Database Servers On Debian 5.0 With ISPConfig 3 Installing The Five Debian Base Systems Installing The Web Server Installing The Mail Server Installing The MySQL Database Server Installing The Primary DNS Server Installing The Secondary DNS Server Adjust The Server Settings In ISPConfig

    3.3 Mirror Setup
    3.3.1 Installing A Web, Email And MySQL Database Cluster On Debian 5.0 With ISPConfig 3 Setting Up The Two Base Systems Installing The Two Servers Installing ISPConfig On The First (Master) Server Installing ISPConfig 3 On The Second Server Configure Replication In ISPConfig Additional Notes

    3.4 Updating
    3.4.1 Creating A Backup
    3.4.2 Command Line Update

    4 Reference
    4.1 Tabs
    4.2 Login
    4.3 Home
    4.4 Tools
    4.4.1 User Settings Password and Language

    4.5 Client
    4.5.1 Clients Add Client Edit Client Edit Client-Templates
    4.5.2 Resellers Add Reseller Edit Reseller

    4.6 Sites
    4.6.1 Websites Website Subdomain for website Aliasdomain for website
    4.6.2 FTP FTP-User
    4.6.3 Shell Shell-User
    4.6.4 WebDAV WebDAV User
    4.6.5 Database Database
    4.6.6 Cron Cron Jobs
    4.6.7 Statistics Web traffic Website quota (Harddisk)
    4.6.8 Folder protection Folder Folder users

    4.7 Email
    4.7.1 Email Accounts Domain Domain Alias Email Mailbox Email Alias Email Forward Email Catchall Email Routing
    4.7.2 Spamfilter Whitelist Blacklist User / Domain Policy
    4.7.3 Fetchmail Fetchmail
    4.7.4 Statistics Mailbox quota Mailbox traffic
    4.7.5 Global Filters Postfix Whitelist Postfix Blacklist Content Filter Relay Recipients
    4.7.6 Mailing List Mailing List

    4.8 DNS
    4.8.1 DNS Wizard Add DNS Zone Import Zone File Templates
    4.8.2 DNS Zones
    4.8.3 Secondary DNS Secondary Zones

    4.9 System
    4.9.1 CP Users Add user Edit user
    4.9.2 System Server Services Server Config Server IP addresses Interface Config
    4.9.3 Firewall Firewall
    4.9.4 Apps & Addons Repositories Packages Updates
    4.9.5 Language Editor Languages New Language Merge Export Import
    4.9.6 Remote Users Add user Edit user
    4.9.7 Remote Actions Do OS-Update Do ISPConfig-Update

    4.10 Monitor
    4.10.1 System State (All Servers) Show Overview Show System-Log Show Jobqueue
    4.10.2 Server to Monitor
    4.10.3 Hardware Information Show CPU Info
    4.10.4 Server State Show Overview Show Update State Show RAID State Show Server Load Show Disk Usage Show Memory Usage Show Services Show OpenVz VE BeanCounter
    4.10.5 Logfiles Show Mail Queue Show Mail Log Show Mail Warn-Log Show Mail Error-Log Show System-Log Show ISPC Cron-Log Show Freshclam-Log Show Clamav-Log Show RKHunter-Log Show fail2ban-Log Show IPTables

    4.11 Help
    4.11.1 Support Send message View messages
    4.11.2 FAQ Manage Sections Manage Questions
    4.11.3 About ISPConfig Version

    4.12 Domains
    4.12.1 Domains Domains

    4.13 VServer
    4.13.1 OpenVZ Virtual Servers OS Templates VM Templates IP addresses

    5 Howtos
    5.1 How Do I Create A Reseller?
    5.2 How Do I Create A Client?
    5.3 How Do I Create A Web Site?
    5.4 How Do I Create An SSL Web Site?
    5.4.1 How Do I Import An Existing SSL Certificate Into A Web Site That Was Created Later In ISPConfig?
    5.5 How Do I Redirect My Web Site To Another Web Site Or To A Specific Directory On The Server?
    5.6 How Do I Create An FTP Account So That I Can Upload Files To My Web Site?
    5.7 How Can I Use Perl/CGI Scripts With My Web Site?
    5.8 How Do I Create An Email Account?
    5.9 How Do I Activate The Spamfilter/Virus Scanner For An Email Account?
    5.10 How Do I Blacklist/Whitelist Email Addresses In The Spamfilter?
    5.11 How Do I Fetch Emails From A Remote Server With ISPConfig And Put The Emails In A Local Email Account?
    5.12 How Do I Create A DNS Zone?
    5.13 How Do I Create A Secondary DNS Zone?
    5.14 How Do I Create A Mirror?
    5.15 How Do I Split Up Services Between Multiple Servers?
    5.16 How Do I Unblock An IP Address That Got Blocked By fail2ban?
    5.17 How Do I Create A Subdomain And Redirect It To A Different Folder/Web Site?
    5.18 How Do I Manually Configure New IP Addresses On My System?
    5.19 How To Build A PureFTPd Debian Package For OpenVZ Virtual Machines (Without Capabilities Enabled)
    5.20 How To Display Hidden Files With PureFTPd On Debian And Ubuntu Linux
    5.21 PureFTPd Does Not Show More Than 2,000 Files On Debian And Ubuntu
    5.22 How To Speed Up Logins In PureFTPd On Debian Or Ubuntu Linux By Disabling Name Resolving
    5.23 How To Enable Verbose Logging In PureFTPd On Debian And Ubuntu Linux
    5.24 How To Enable FTPS For PureFTPd On Debian And Ubuntu Linux
    5.25 How Can I Access SquirrelMail From My Web Sites?
    5.25.1 Apache
    5.25.2 nginx
    5.26 How Can I Access phpMyAdmin From My Web Sites?
    5.26.1 Apache
    5.26.2 nginx
    5.27 How Can I Access Mailman From My Web Sites?
    5.27.1 Apache
    5.27.2 nginx

    6 Security Considerations
    6.1 How Do I Disable Certain PHP Functions?
    6.2 Enabling SSL For The ISPConfig Web Interface
    6.3 Using SuExec For The ISPConfig Web Interface
    6.4 What Are Secure Settings For Web Sites Created Through ISPConfig?
    6.5 How Do I Make fail2ban Monitor Additional Services?
    6.5.1 PureFTPd
    6.5.2 SASL
    6.5.3 Courier
    6.5.4 Dovecot

    7 Troubleshooting
    7.1 How Do I Find Out What Is Wrong If ISPConfig Does Not Work?
    Last edited: Dec 1, 2011
    Richardmax likes this.
  2. Toucan

    Toucan Member

    Top job. Your efforts much appreciated.
  3. Doug G

    Doug G Member HowtoForge Supporter

    It's been nice visiting here but I guess I'll need some payment before returning to these forums.
  4. ferrao

    ferrao New Member

    Great Stuff!!!

    Proper 300 page manual is a big achievement!
    Looking forward to reading it, i'm ordering my copy on the hope that is speeds up Ispconfig 3 development!

    Looking at the features in 3.0.3 put a smile on my face and can't hardly wait to upgrade!
  5. drewb0y

    drewb0y Member

    Already purchased my copy. The cost is a small price to ask to support such a fantastic project.

    How many people are using their ispconfig3 server for paying customers?

    If you use it and like it, give a little back!
  6. wahid

    wahid New Member

    PayPal without Credit-Card

    Hi Falko,

    I'd like to pay for the Manual, but unfortunately I don't own a Credit-Card. I use PayPal only with my german debit account. Is there any way to offer a possiblity to german PayPal-User to pay per direct debit, since Projektfarm is registered in Germany?

    Thanks is advance
  7. ikrudolf

    ikrudolf Member

    Just purchased the manual, tnx!
  8. yoplait

    yoplait Member

    I'm going to take a copy with my association too, but I have to wait to validate my paypal account...

    I was wondering about a french version. Is it made ?

    Till & Falko, I'm actually in "sick leave", so I have some time... Do you want me to begin a translation in french ? Is someone have begin this work ?

    I wait for your answer.
  9. falko

    falko Super Moderator ISPConfig Developer

    Please write an email to Till (info [at] projektfarm [dot] de), and we will find a solution. :)
  10. falko

    falko Super Moderator ISPConfig Developer

    No, it isn't planned. Currently no translations are planned as it would simply take too much time...

    The problem is that such a translation would have to be maintained because the original manual will be modified over time, and we don't have the resources to do that. Therefore we prefer to just have an English version. But thanks for the offer. :)
  11. yoplait

    yoplait Member

    As you want.
    When my paypal account will be ready, I will see how big is the work to translate, and maybe we'll talk about this later ;) .
    Thanks for this manual anyway !
  12. Agent_M

    Agent_M Member

    Great work on the Manual, have just subscribed and downloaded, have only had chance to have a brief look, but looks great ( will have a better look this weekend when I upgrade to 3.0.3 ).

    I do have a question though.

    In the case of a customer actually needing or wanting access to the control panel, I would like to be able to give them a "user" version of the manual, and without my online name on it ( I don't mind however if this is substituted for my real name and business email address ).

    For the most part my customers won't need this, but in the case of those who do, is there a way we would be able to make this possible? ( without me infringing on your copyright of course ).

    Great work again, am really looking forward to having a better read of it.
  13. till

    till Super Moderator Staff Member ISPConfig Developer

    We are currently working on licensing options for hosting agencies / resellers for the manual and evaluating to make a "light" version of the manual. If you like to get informed when it becomes available, then please send me an email to info [at] projektfarm [dot] de
  14. Antennipasi

    Antennipasi ISPConfig Developer ISPConfig Developer

    Have to say after quick peek the manual, it's awesome. How you did you find time to do it? I usually write couple pages to clients after have done something, and it could take hours to convert nerdy language to understandable form. Most times i even need help to do it :eek:

    Very anxious to have some lite version with ability to translate some pages to clients. I will send reminder to above email.
  15. autogun

    autogun New Member

    Just got my copy now!

    Thank you guys for this wonderful project!
  16. spikes

    spikes Member

    Payment sent. Thank you so much!
  17. otacon

    otacon New Member

    Corrupted PDF

    Everytime I download the pdf it comes up corrupted... who would I contact about this issue?

    I will keep trying, since the secondary link doesn't seem to let me download anything, but I need some help. I would love to see the manual.
  18. falko

    falko Super Moderator ISPConfig Developer

    You can simply reply to the email with the download links, and we will try to help. Please give us details about your OS and browser.
  19. otacon

    otacon New Member

    Issues downloading

    Yeah... I am using Windows 7 With internet explorer, but I just borrowed my old macintosh and it downloaded just fine onto that.

    My Windows machine must be having issues.
  20. falko

    falko Super Moderator ISPConfig Developer


    I've just tested again on Windows 7 and Internet Explorer and had no issues. Must be a problem with your Windows system.

Share This Page