Merge lp:~bencer/serverguide/serverguide-precise-zentyal into lp:~ubuntu-core-doc/serverguide/precise

[Jorge Salamero Sanz]

These are the changed needed to include Zentyal chapter.

[Peter Matulis (petermatulis)]

Hi Jorge, could you explain what this means:

On Ubuntu 12.04 release, the current stable version is 2.2, based on the previous Ubuntu LTS. Ubuntu 12.04 comes with Zentyal 2.3 packages."

It appears self-contradictory.

You then go on to say:

"If you want to upgrade to a new stable release you can use Zentyal Team PPA."

Please provide more info on what version users can expect to find in the PPA as well as instructions to install the PPA-based packages.

When I search for packages on an updated Precise I do not find packages named such as 'zentyal-core' or 'zentyal-common'. In fact, I do not find any zentyal-* packages at all:

$ apt-cache search zentyal
ebox - Zentyal - Core
ebox-ca - Zentyal - Certification Authority
ebox-dhcp - Zentyal - DHCP Service
ebox-dns - Zentyal - DNS Service
ebox-firewall - Zentyal - Firewall
ebox-network - Zentyal - Network Configuration
ebox-ntp - Zentyal - NTP Service
ebox-objects - Zentyal - Network Objects
ebox-openvpn - Zentyal - VPN Service
ebox-printers - Zentyal - Printer Sharing
ebox-samba - Zentyal - File Sharing
ebox-services - Zentyal - Network Services
ebox-squid - Zentyal - HTTP Proxy (Cache and Content Filter)
ebox-usersandgroups - Zentyal - Users and Groups
libebox - Zentyal - Common Library

Furthermore, there are also version mismatches. From the quote I gave above, I should be seeing, at the very least, version 2.2 but this is what I get:

$ apt-cache policy ebox
ebox:
  Installed: (none)
  Candidate: 2.0.16-0ubuntu2
  Version table:
     2.0.16-0ubuntu2 0
        500 http://is.archive.ubuntu.com/ubuntu/ precise/universe amd64 Packages

[Jorge Salamero Sanz (bencer)]

On 03/19/2012 08:39 PM, Peter Matulis wrote:
> Hi Jorge, could you explain what this means:
>
> On Ubuntu 12.04 release, the current stable version is 2.2, based on the previous Ubuntu LTS. Ubuntu 12.04 comes with Zentyal 2.3 packages."
>
> It appears self-contradictory.
>
> You then go on to say:
>
> "If you want to upgrade to a new stable release you can use Zentyal Team PPA."
>
> Please provide more info on what version users can expect to find in the PPA as well as instructions to install the PPA-based packages.

I didn't want to provide more info here because PPA related stuff is not
part of the official archive so I wouldn't explain in the -server-guide.
Maybe I can point to a wiki page that will contain updated and more
detailed info on this?

>
> When I search for packages on an updated Precise I do not find packages named such as 'zentyal-core' or 'zentyal-common'. In fact, I do not find any zentyal-* packages at all:
>
> $ apt-cache search zentyal
> ebox - Zentyal - Core
> ebox-ca - Zentyal - Certification Authority
> ebox-dhcp - Zentyal - DHCP Service
> ebox-dns - Zentyal - DNS Service
> ebox-firewall - Zentyal - Firewall
> ebox-network - Zentyal - Network Configuration
> ebox-ntp - Zentyal - NTP Service
> ebox-objects - Zentyal - Network Objects
> ebox-openvpn - Zentyal - VPN Service
> ebox-printers - Zentyal - Printer Sharing
> ebox-samba - Zentyal - File Sharing
> ebox-services - Zentyal - Network Services
> ebox-squid - Zentyal - HTTP Proxy (Cache and Content Filter)
> ebox-usersandgroups - Zentyal - Users and Groups
> libebox - Zentyal - Common Library
>
> Furthermore, there are also version mismatches. From the quote I gave above, I should be seeing, at the very least, version 2.2 but this is what I get:
>
> $ apt-cache policy ebox
> ebox:
> Installed: (none)
> Candidate: 2.0.16-0ubuntu2
> Version table:
> 2.0.16-0ubuntu2 0
> 500 http://is.archive.ubuntu.com/ubuntu/ precise/universe amd64 Packages
>

Yes, zentyal packages hasn't still hit the archive, but FFe has been
granted and packages should be on the NEW queue by now:
https://bugs.launchpad.net/ubuntu/+source/ebox/+bug/928501

[Jorge Salamero Sanz (bencer)]

Hi Peter,

you can see that Zentyal packages just made into the archive: https://bugs.launchpad.net/ubuntu/+source/ebox/+bug/928501/comments/41.

Regards

[Peter Matulis (petermatulis)]

I see packages are waiting to be uploaded to the archive now [1]. You could have provided some clarity there.

Please review this line:

"On Ubuntu 12.04 release, the current stable version is 2.2, based on the previous Ubuntu LTS. Ubuntu 12.04 comes with Zentyal 2.3 packages."

It suggests that version 2.2 is available. I understand that you will be providing a development version of your software (2.3). Is this correct?

Re PPAs, add what benefit there is in using your PPA-based packages and what version(s) will be available. For instructions on how to enable a PPA use this link:

https://help.ubuntu.com/12.04/ubuntu-help/addremove-ppa.html

I will have more comments after I'm able to install the software (once the packages become available).

-----

[1]: https://launchpad.net/ubuntu/precise/+queue

review: Needs Fixing

[Jorge Salamero Sanz (bencer)]

Hi Peter,

http://packages.ubuntu.com/search?keywords=zentyal

packages just hit the archive, let me know if you have any other commends and I will prepare a new version with your feedback.

[Peter Matulis (petermatulis)]

I see the packages and I did a test install of 'zentyal-users'. Seemed to work.

Follow up with the rest of my last comment.

review: Needs Fixing

[lp:~bencer/serverguide/serverguide-precise-zentyal]

48. By Jorge Salamero Sanz on 2012-03-24

Deleted self-contradictory sentence.

[Jorge Salamero Sanz (bencer)]

Fixed the self-contradictory sentence, should be ready to merge now. Thanks!

[Peter Matulis (petermatulis)]

For instructions on how to enable the PPA, add this link:

https://help.ubuntu.com/12.04/ubuntu-help/addremove-ppa.html

This was also mentioned before.

review: Needs Fixing

[lp:~bencer/serverguide/serverguide-precise-zentyal]

49. By Jorge Salamero Sanz on 2012-03-25

Improved PPA section.

[Jorge Salamero Sanz (bencer)]

Peter, you will find with this new commit some improvements based on your feedback.

[Peter Matulis (petermatulis)]

Thank you. Approved.

review: Approve

=== modified file 'serverguide/C/remote-administration.xml'
--- serverguide/C/remote-administration.xml	2012-03-20 17:11:11 +0000
+++ serverguide/C/remote-administration.xml	2012-03-25 11:25:20 +0000
@@ -395,4 +395,387 @@
 
     </sect2>
   </sect1>
+  <sect1 id="zentyal" status="review">
+    <title>Zentyal</title>
+
+      <para>
+      <application>Zentyal</application> is a Linux small business server, that
+      can be configured as a Gateway, Infrastructure Manager, Unified Threat Manager,
+      Office Server, Unified Communication Server or a combination of them.
+      All network services managed by Zentyal are tightly integrated,
+      automating most tasks. This helps to avoid errors in the network
+      configuration and administration and allows to save time.
+      <application>Zentyal</application> is open source, released under the GNU
+      General Public License (GPL) and runs on top of Ubuntu GNU/Linux.
+      </para>
+
+      <para>
+      <application>Zentyal</application> consists of a serie of packages
+      (usually one for each module) that provide a web interface to configure
+      the different servers or services. The configuration is stored on a
+      key-value <application>Redis</application> database but users, groups
+      and domains related configuration is on <application>OpenLDAP
+      </application>. When you configure any of the available parameters
+      through the web interface, final configuration files are overwritten
+      using the configuration templates provided by the modules. 
+      The main advantages of using <application>Zentyal</application> are:
+      unified, graphical user interface to configure all network services and
+      high, out-of-the-box integration between them.
+      </para>
+
+    <sect2 id="zentyal-installation" status="review">
+      <title>Installation</title>
+
+      <para>
+      Zentyal 2.3 is available on Ubuntu 12.04 Universe repository. The modules
+      available are:
+      </para>
+
+      <itemizedlist>
+        <listitem>
+          <para>
+          zentyal-core &amp; zentyal-common: the core of the
+          <application>Zentyal</application> interface and the common libraries
+          of the framework. Also include the logs and events modules that
+          give the administrator an interface to view the logs and generate
+          events from them.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-network: manages the configuration of the network. From the
+          interfaces (supporting static IP, DHCP, VLAN, bridges or PPPoE),
+          to multiple gateways when having more than one Internet connection,
+          load balancing and advanced routing, static routes or dynamic DNS.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-objects &amp; zentyal-services: provide an abstration level
+          for network addresses (e.g. LAN instead of 192.168.1.0/24) and ports
+          named as services (e.g. HTTP instead of 80/TCP).
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-firewall: configures the <application>iptables</application>
+          rules to block forbiden connections, NAT and port redirections.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ntp: installs the NTP daemon to keep server on time and allow
+          network clients to synchronize their clocks against the server.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-dhcp: configures <application>ISC DHCP</application> server
+          supporting network ranges, static leases and other advanced options
+          like NTP, WINS, dynamic DNS updates and network boot with PXE.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-dns: brings <application>ISC Bind9</application> DNS server
+          into your server for caching local queries as a forwarder or as an
+          authoritative server for the configured domains. Allows to configure
+          A, CNAME, MX, NS, TXT and SRV records.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ca: integrates the management of a Certification Authority
+          within Zentyal so users can use certificates to authenticate against
+          the services, like with <application>OpenVPN</application>.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-openvpn: allows to configure multiple VPN servers and clients
+          using <application>OpenVPN</application> with dynamic routing
+          configuration using <application>Quagga</application>.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-users: provides an interface to configure and manage users
+          and groups on <application>OpenLDAP</application>. Other services
+          on Zentyal are authenticated against LDAP having a centralized
+          users and groups management. It is also possible to synchronize
+          users, passwords and groups from a <application>Microsoft Active
+          Directory</application> domain.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-squid: configures <application>Squid</application> and
+          <application>Dansguardian</application> for speeding up browsing
+          thanks to the caching capabilities and content filtering.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-samba: allows <application>Samba</application> configuration
+          and integration with existing LDAP. From the same interface you can
+          define password policies, create shared resources and assign
+          permissions.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-printers: integrates <application>CUPS</application> with
+          <application>Samba</application> and allows not only to configure
+          the printers but also give them permissions based on LDAP users
+          and groups.
+          </para>
+        </listitem>
+      </itemizedlist>
+
+      <para>
+      To install <application>Zentyal</application>, in a terminal on the
+      <emphasis>server</emphasis> enter (where &lt;zentyal-module&gt; is
+      any of the modules from the previous list):
+      </para>
+
+<screen>
+<command>sudo apt-get install &lt;zentyal-module&gt;</command>
+</screen>
+
+      <note>
+      <para>
+      <application>Zentyal</application> publishes one major stable release
+      once a year (in September) based on latest Ubuntu LTS release. Stable
+      releases always have even minor numbers (e.g. 2.2, 3.0) and beta
+      releases have odd minor numbers (e.g. 2.1, 2.3). Ubuntu 12.04 comes
+      with <application>Zentyal</application> 2.3 packages. If you want to
+      upgrade to a new stable release published after the release of Ubuntu
+      12.04 you can use <ulink url="https://launchpad.net/~zentyal/">Zentyal
+      Team PPA</ulink>. Upgrading to newer stable releases can provide you
+      minor bugfixes not backported to 2.3 in Precise and newer features.
+      </para>
+      </note>
+
+      <tip>
+      <para>
+      If you need more information on how to add packages from a PPA see
+      <ulink url="https://help.ubuntu.com/12.04/ubuntu-help/addremove-ppa.html">
+      Add a Personal Package Archive (PPA)</ulink>.
+      </para>
+      </tip>
+
+      <note>
+      <para>
+      Not present on Ubuntu Universe repositories, but on
+      <ulink url="https://launchpad.net/~zentyal/">Zentyal Team PPA</ulink>
+      you will find these other modules:
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>
+          zentyal-antivirus: integrates <application>ClamAV</application>
+          antivirus with other modules like the proxy, file sharing or
+          mailfilter.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-asterisk: configures <application>Asterisk</application>
+          to provide a simple PBX with LDAP based authentication.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-bwmonitor: allows to monitor bandwith usage of your LAN
+          clients.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-captiveportal: integrates a captive portal with the firewall
+          and LDAP users and groups.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ebackup: allows to make scheduled backups of your server using
+          the popular <application>duplicity</application> backup tool.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ftp: configures a FTP server with LDAP based authentication.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ids: integrates a network intrusion detection system.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-ipsec: allows to configure IPsec tunnels using
+          <application>OpenSwan</application>.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-jabber: integrates <application>ejabberd</application>
+          XMPP server with LDAP users and groups.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-thinclients: a <application>LTSP</application> based
+          thin clients solution.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-mail: a full mail stack including <application>Postfix
+          </application> and <application>Dovecot</application> with LDAP
+          backend.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-mailfilter: configures <application>amavisd</application> with
+          mail stack to filter spam and attached virus.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-monitor: integrates <application>collectd</application> 
+          to monitor server performance and running services.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-pptp: configures a <application>PPTP</application> VPN server.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-radius: integrates <application>FreeRADIUS</application> with
+          LDAP users and groups.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-software: simple interface to manage installed
+          <application>Zentyal</application> modules and system updates.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-trafficshaping: configures traffic limiting rules to do
+          bandwidth throttling and improve latency.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-usercorner: allows users to edit their own LDAP attributes
+          using a web browser.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-virt: simple interface to create and manage virtual machines
+          based on <application>libvirt</application>.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-webmail: allows to access your mail using the popular
+          <application>Roundcube</application> webmail.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-webserver: configures <application>Apache</application>
+          webserver to host different sites on your machine.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          zentyal-zarafa: integrates <application>Zarafa</application>
+          groupware suite with <application>Zentyal</application> mail stack
+          and LDAP.
+          </para>
+        </listitem>
+      </itemizedlist>
+      </note>
+
+    </sect2>
+
+    <sect2 id="zentyal-firststeps" status="review">
+      <title>First steps</title>
+
+      <para>
+      Any system account belonging to the sudo group is allowed to log into
+      <application>Zentyal</application> web interface. If you are using the
+      user created during the installation, this should be in the sudo group
+      by default.
+      </para>
+
+      <tip>
+      <para>
+      If you need to add another user to the sudo group, just
+      execute:
+      </para>
+<screen>
+<command>sudo adduser username sudo</command>
+</screen>
+      </tip>
+
+      <para>
+      To access <application>Zentyal</application> web interface, browse into
+      https://localhost/ (or the IP of your remote server). As Zentyal creates
+      its own self-signed SSL certificate, you will have to accept a security
+      exception on your browser.
+      </para>
+
+      <para>
+      Once logged in you will see the dashboard with an overview of your
+      server. To configure any of the features of your installed modules, go
+      to the different sections on the left menu. When you make any changes,
+      on the upper right corner appears a red <emphasis>Save changes</emphasis>
+      button that you must click to save all configuration changes.
+      To apply these configuration changes in your server, the module
+      needs to be enabled first, you can do so from the <emphasis>Module Status
+      </emphasis> entry on the left menu. Every time you enable a module, a
+      pop-up will appear asking for a confirmation to perform the necessary
+      actions and changes on your server and configuration files.
+      </para>
+
+      <note>
+      <para>
+      If you need to customize any configuration file or run certain actions
+      (scripts or commands) to configure features not available on
+      <application>Zentyal</application> place the custom configuration file
+      templates on /etc/zentyal/stubs/&lt;module&gt;/ and the hooks on
+      /etc/zentyal/hooks/&lt;module&gt;.&lt;action&gt;.
+      </para>
+      </note>
+
+    </sect2>
+
+    <sect2 id="zentyal-references" status="review">
+      <title>References</title>
+      <para>
+      <ulink url="http://doc.zentyal.org/">Zentyal Official Documentation
+      </ulink> page.
+      </para>
+      <para>
+      See also <ulink url="http://trac.zentyal.org/wiki/Documentation">Zentyal
+      Community Documentation</ulink> page.
+      </para>
+      <para>
+      And don't forget to visit the <ulink url="http://forum.zentyal.org/">forum
+      </ulink> for community support, feedback, feature requests, etc.
+      </para>
+    </sect2>
+
+  </sect1>
+
 </chapter>