UbuntuServerGuide

Ubuntu Server Guide - Ubuntu 14.04

Note: The guide is now published only for LTS releases. The first Ubuntu release affected by this change will be 14.04. Unofficial guides of the current branch will occasionally be made available online.

The Ubuntu Server Guide project is part of System Documentation and, as such, everything that has been written on that topic applies equally here. Follow the above links to understand the process of contributing to Ubuntu System Documentation.

The purpose of this page is to organize contributions made to the Server Guide for the upcoming Ubuntu release. It is also cool to see what other people are up to. Subscribe to this page!

In addition to this focus wiki page, there is a focus Launchpad team replete with a mailing list. If you are committed to the improvement of the Guide please do become a member of the Ubuntu Server Guide Helpers team!

Here are ways to contribute, in order of priority:

  1. Review on a technical and style level.

  2. Correct (and/or Triage) a filed bug. Ubuntu Server Guide Bugs

  3. Extend by adding a significant amount of new information (possibly new sub-chapter or an entirely new chapter). Let me know of your intentions.

  4. Propose ideas for improvement (new topics, re-organization). There is a Discussion section at the bottom.

Useful links:

Kickstart

Here are some sample core commands for someone (local user john with a Launchpad id of johnlpid) wishing to review sub-chapter 7.1 (OpenLDAP section under Network Authentication chapter) for Ubuntu 13.10. Please do read up on what they do; it's all explained in the links at the top of the page.

Change text in the below commands to fit your own situation (ex: do not paste in 7.1 if you're not reviewing 7.1).

0. Install the software

sudo apt-get install bzr docbook docbook-xsl xsltproc libxml2-utils yelp-tools yelp-xsl fop gnome-doc-utils make

1. Download the current branch

mkdir ~/sguide-1404
cd ~/sguide-1404
bzr branch lp:serverguide serverguide-review-7.1
cd serverguide-review-7.1
scripts/validate.sh serverguide/C/serverguide.xml

{ STOP if the above does not validate (some warnings may be benign); bring this up in the ubuntu-doc mailing list or try to correct the errors yourself }

2. Review and edit the material (a little bit at a time)

vi serverguide/C/network-auth.xml
make serverguide-html

3. View and verify the changes in your browser

firefox build/serverguide/C/openldap-server.html

Repeat steps #2 and #3 until crispy.

4. Send the modified repository to your Launchpad account

scripts/validate.sh serverguide/C/serverguide.xml

{ STOP if the above does not validate (some warnings may be benign); correct the errors }

bzr commit -m 'Reviewing sub-chapter 7.1; other notes can go here'
bzr push lp:~johnlpid/serverguide/serverguide-review-7.1

Variations for the commit lines include specifying the related launchpad bug report, if one exists:

bzr commit --fixes lp:<bug-#> -m 'Reviewing sub-chapter 7.1; other notes can go here'

And specifying multiple bug reports, if appropriate:

bzr commit --fixes lp:<bug-#> --fixes lp:<bug-#> --fixes lp:<bug-#> -m 'Reviewing 7.1; notes can go here'

5. Submit a proposal to merge the modifications with the main branch

Enter the Code section of your Launchpad account, select the appropriate branch, and submit a merge proposal ("Propose for merging").

Alternative help method

Although the above is the preferred method for contributing, if you find it too laborious or you just can't make it work an alternative route is to create a bug about what you think is wrong in the guide and include some replacement text. Of course, if you are working already from an existing bug then just add the text in a new bug comment. If you have multiple bugs that affect the same sub-chapter then create a single bug for all of them.

Contribution table

The stuff in green is the priority this cycle.

Using the following symbols...

(o)

TO DO

(./)

IN PROGRESS

Warning /!\

MERGE PROPOSED

(OK)

MERGE ACCEPTED, I'M DONE!

Sad <:(

MERGE REJECTED

Awesome! B)

NOTHING TO DO, IT'S GOOD AS IS

(i)

COMMENT

...let us know what you want to do, where you're at, and any comments you may have. While In Progress, update the % Complete column regularly.

Sub-chapter

Your name

Your Launchpad ID

Review

Extension

Comments

% Complete

1 - Introduction

1.1 -- Support

(o)

2 - Installation

2.1 -- Preparing to Install

(o)

2.2 -- Installing from CD

(o)

2.3 -- Upgrading

(o)

2.4 -- Advanced Installation

(o)

2.5 -- Kernel Crash Dumps

(o)

3 - Package Management

3.1 -- Introduction

(o)

3.2 -- dpkg

(o)

3.3 -- Apt-Get

(o)

3.4 -- Aptitude

(o)

3.5 -- Automatic Updates

(o)

3.6 -- Configuration

(o)

3.7 -- References

(o)

4 - Networking

4.1 -- Network Configuration

(o)

4.2 -- TCP/IP

(o)

4.3 -- Dynamic Host Configuration Protocol (DHCP)

(o)

4.4 -- Time Synchronisation with NTP

(o)

5 - Storage

5.1 -- LVM

(o)

5.2 -- Software RAID (md)

(o)

5.3 -- DM Multipath

(o)

5.4 -- Ceph

Peter Matulis

petermatulis

(o)

20%

6 - Remote Administration

6.1 -- OpenSSH Server

(o)

6.2 -- Puppet

(o)

6.3 -- Zentyal

(o)

7 - Network Authentication

7.1 -- OpenLDAP Server

(o)

7.2 -- Samba and LDAP

(o)

7.3 -- Kerberos

(o)

7.4 -- Kerberos and LDAP

(o)

8 - Domain Name Service (DNS)

8.1 -- Installation

(o)

8.2 -- Configuration

(o)

8.3 -- Troubleshooting

(o)

8.4 -- References

(o)

9 - Security

9.1 -- User Management

(o)

9.2 -- Console Security

(o)

9.3 -- Firewall

(o)

9.4 -- AppArmor

(o)

9.5 -- Certificates

(o)

9.6 -- eCryptfs

(o)

10 - Monitoring

10.1 -- Overview

(o)

10.2 -- Nagios

(o)

10.3 -- Munin

(o)

11 - Web Servers

11.1 -- HTTPD - Apache2 Web Server

Derek Cameron

(OK)

MP: #200021

11.2 -- PHP5 - Scripting Language

(o)

11.3 -- Squid - Proxy Server

(o)

11.4 -- Ruby on Rails

(o)

11.5 -- Apache Tomcat

(o)

12 - Databases

12.1 -- MySQL

(o)

12.2 -- PostgreSQL

(o)

13 - LAMP Applications

13.1 -- Overview

(o)

13.2 -- Moin Moin

(o)

13.3 -- MediaWiki

(o)

13.4 -- phpMyAdmin

(o)

13.5 -- WordPress

Doug Smythies

(OK)

bug 1264963

14 - File Servers

14.1 -- FTP Server

(o)

14.2 -- Network File System (NFS)

(o)

14.3 -- iSCSI Initiator

(o)

14.4 -- CUPS - Print Server

(o)

15 - Email Services

15.1 -- Postfix

(o)

15.2 -- Exim4

(o)

15.3 -- Dovecot Server

(o)

15.4 -- Mailman

(o)

15.5 -- Mail Filtering

(o)

16 - Chat Applications

16.1 -- Overview

(o)

16.2 -- IRC Server

(o)

16.3 -- Jabber Instant Messaging Server

(o)

17 - Version Control Systems

17.1 -- Bazaar

(o)

17.2 -- Git

(o)

17.3 -- Subversion

(o)

17.4 -- References

(o)

18 - Samba

18.1 -- Introduction

(o)

18.2 -- File Server

(o)

18.3 -- Print Server

(o)

18.4 -- Securing File and Print Server

(o)

18.5 -- As a Domain Controller

(o)

18.6 -- Active Directory Integration

(o)

19 - Backups

19.1 -- Shell Scripts

(o)

19.2 -- Archive Rotation

(o)

19.3 -- Bacula

(o)

20 - Virtualization

20.1 -- libvirt

(o)

20.2 -- Cloud Images and uvtool

Louis Bouchard

louis-bouchard

Warning /!\

MP: #212429

20.3 -- Ubuntu Cloud

(o)

20.4 -- LXC

Serge Hallyn

serge-hallyn

(OK)

21 - Control Groups

21.1 -- Overview

Serge Hallyn

serge-hallyn

(OK)

NEW

21.2 -- Filesystem

Serge Hallyn

serge-hallyn

(OK)

NEW

21.3 -- Delegation

Serge Hallyn

serge-hallyn

(OK)

NEW

21.4 -- Manager

Serge Hallyn

serge-hallyn

(OK)

NEW

21.5 -- Resources

Serge Hallyn

serge-hallyn

(OK)

NEW

22 - Clustering

22.1 -- DRBD

(o)

23 - VPN

23.1 -- OpenVPN

(o)

24 - Other Useful Applications

24.1 -- pam_motd

(o)

24.2 -- etckeeper

Peter Matulis

petermatulis

(o)

24.3 -- Byobu

Peter Matulis

petermatulis

(o)

24.4 -- References

Peter Matulis

petermatulis

(o)

A - Appendix

A.1 -- Reporting Bugs in Ubuntu Server Edition

Peter Matulis

petermatulis

(./)

65%

Getting help

Here are the best ways to get answers to any questions you may have:

Deadline

All final merge proposals should be made in time to be accepted by March 20th, 2014. See DocumentationStringFreeze and TrustyTahrReleaseSchedule.

Discussion

Here you can add your thoughts on

  • Re-organization of topics
  • Addition of missing topics:
    • Juju
    • Git / gitolite server : done by Chris Glass
  • Anything else

Notes:

  • sub-section 3.1.4 is about named-checkzone. There should also be a 3.1.5 about named-checkconf.

Proposed changes to development

We are proposing moving the development and publishing of the Guide to the rolling release model as well as changing the management/scheduling of translations. See here:

Blueprint: "Ubuntu Server Guide - LTS only"

DocumentationTeam/SystemDocumentation/UbuntuServerGuide (last edited 2014-03-24 20:39:37 by dsmythies)