PreciseUbuntuServerGuide

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!

Here are the different ways to contribute, in order of priority:

  1. Review of existing material on a technical and style level.

  2. Extension of existing material (significant amount of new information, possibly new sub-chapter) or an entirely new chapter. Let me know of your intentions.

There is a Discussion section at the bottom if you feel a topic is missing or if you have some other idea for improvement.

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 6.1 (OpenLDAP section under Network Authentication chapter) for Ubuntu 12.04. 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 6.1 if you're not reviewing 6.1).

1. Get the repository

sudo apt-get install bzr docbook docbook-xsl xsltproc libxml2-utils
mkdir ~/sguide-1204
cd ~/sguide-1204
bzr branch lp:serverguide serverguide-review-6.1

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

cd serverguide-review-6.1
vi serverguide/C/network-auth.xml
make serverguide

3. View and verify the changes in your browser

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

Repeat the above 2 steps until crispy.

4. Send the modified repository to your Launchpad account

scripts/validate.sh serverguide/C/serverguide.xml
bzr commit -m 'Reviewing sub-chapter 6.1; other notes can go here'
bzr push lp:~johnlpid/serverguide/serverguide-review-6.1

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.

Contribution table

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.

Active code reviews

Sub-chapter

Your name

Your Launchpad ID

Review

Extension

Comments

% Complete

1 - Introduction

1.1 -- Support

Hannie Dumoleyn

lafeber-dumoleyn

Awesome! B)

2 - Installation

2.1 -- Preparing to Install

Hannie Dumoleyn

lafeber-dumoleyn

(OK)

Revision 35

2.2 -- Installing from CD

Hannie Dumoleyn

lafeber-dumoleyn

(OK)

Revision 35

2.3 -- Upgrading

Hannie Dumoleyn

lafeber-dumoleyn

Awesome! B)

2.4 -- Advanced Installation

Hannie Dumoleyn

lafeber-dumoleyn

(OK)

Revision 35

2.5 -- Kernel Crash Dumps

Louis Bouchard

louis-bouchard

(OK)

(i) this is a new sub-chapter

3 - Package Management

3.1 -- Introduction

Matt Rudge

mrudge

(OK)

100%

3.2 -- dpkg

Matt Rudge

mrudge

(OK)

100%

3.3 -- Apt-Get

Matt Rudge

mrudge

(OK)

100%

3.4 -- Aptitude

Matt Rudge

mrudge

(OK)

100%

3.5 -- Automatic Updates

Matt Rudge

mrudge

(OK)

100%

3.6 -- Configuration

Matt Rudge

mrudge

(OK)

100%

3.7 -- References

Matt Rudge

mrudge

Awesome! B)

100%

4 - Networking

4.1 -- Network Configuration

Alex Moldovan

alexmoldovan

(OK)

4.2 -- TCP/IP

Alex Moldovan

alexmoldovan

Awesome! B)

4.3 -- Dynamic Host Configuration Protocol (DHCP)

Alex Moldovan

alexmoldovan

(OK)

4.4 -- Time Synchronisation with NTP

Jonathan Davies

jpds

Sad <:(

5 - Storage

5.1 -- LVM

Peter Petrakis

peter-petrakis

(o)

5.2 -- Software RAID (md)

Peter Petrakis

peter-petrakis

(o)

5.3 -- DM Multipath

Peter Petrakis

peter-petrakis

(OK)

6 - Remote Administration

6.1 -- OpenSSH Server

Matt Rudge

mrudge

(OK)

(i) delayed due to dead laptop

6.1 -- OpenSSH Server

Doug Smythies

dsmythies

(./)

(i) Note 1. Aborted, Not going to get this one done.

0%

6.2 -- Puppet

(o)

6.3 -- Zentyal

Jorge Salamero Sanz

bencer

(OK)

(i) this is a new sub-chapter

7 - Network Authentication

7.1 -- OpenLDAP Server

Peter Matulis

petermatulis

Awesome! B)

7.2 -- Samba and LDAP

(o)

7.3 -- Kerberos

Mauricio Tavares

raubvogel

(OK)

(i) Small proposed changes

7.4 -- Kerberos and LDAP

Mauricio Tavares

raubvogel

(OK)

(i) Small proposed changes

8 - Domain Name Service (DNS)

8.1 -- Installation

Doug Smythies

dsmythies

Awesome! B)

8.2 -- Configuration

Doug Smythies

dsmythies

(OK)

(i) Small proposed changes

8.3 -- Troubleshooting

Doug Smythies

dsmythies

(OK)

(i) bug 864259

8.4 -- References

Doug Smythies

dsmythies

(OK)

9 - Security

9.1 -- User Management

Doug Smythies

dsmythies

(OK)

9.2 -- Console Security

Doug Smythies

dsmythies

Awesome! B)

9.3 -- Firewall

Doug Smythies

dsmythies

(OK)

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

Doug Smythies

dsmythies

(OK)

11.1 -- HTTPD - Apache2 Web Server

Doug Smythies

dsmythies

(OK)

Note 1

11.2 -- PHP5 - Scripting Language

Doug Smythies

dsmythies

Awesome! B)

11.3 -- Squid - Proxy Server

(o)

11.4 -- Ruby on Rails

(o)

11.5 -- Apache Tomcat

(o)

12 - Databases

12.1 -- MySQL

Paul Graydon

twirrim

(OK)

12.2 -- PostgreSQL

(o)

13 - LAMP Applications

13.1 -- Overview

GiuseppeTerrasi

giuseppeterrasi

(OK)

See revision 38.

13.2 -- Moin Moin

GiuseppeTerrasi

giuseppeterrasi

(OK)

See revision 37.

13.3 -- MediaWiki

GiuseppeTerrasi

giuseppeterrasi

(OK)

13.4 -- phpMyAdmin

Awesome! B)

14 - File Servers

14.1 -- FTP Server

Hannie

lafeber-dumoleyn

(OK)

(i) Revision 56

14.1 -- FTP Server

Doug Smythies

dsmythies

(OK)

Bug: 912796 Note 1

14.2 -- Network File System (NFS)

Hannie

lafeber-dumoleyn

Awesome! B)

(i) No changes

14.3 -- iSCSI Initiator

Hannie

lafeber-dumoleyn

(OK)

Revision 56

14.4 -- CUPS - Print Server

Hannie

lafeber-dumoleyn

Awesome! B)

(i) No changes

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

Louis Bouchard

louis-bouchard

Awesome! B)

16.2 -- IRC Server

Louis Bouchard

louis-bouchard

Awesome! B)

16.3 -- Jabber Instant Messaging Server

Louis Bouchard

louis-bouchard

Awesome! B)

17 - Version Control Systems

17.1 -- Bazaar

(o)

17.2 -- Subversion

(o)

17.3 -- CVS Server

(o)

17.4 -- References

(o)

18 - Windows Networking

18.1 -- Introduction

(o)

18.2 -- Samba File Server

(o)

18.3 -- Samba Print Server

(o)

18.4 -- Securing a Samba File and Print Server

(o)

18.5 -- Samba as a Domain Controller

(o)

18.6 -- Samba Active Directory Integration

(o)

19 - Backups

19.1 -- Shell Scripts

Matt Rudge

mrudge

(OK)

19.1 -- Shell Scripts

Doug Smythies

dsmythies

(OK)

Note 1

19.2 -- Archive Rotation

Matt Rudge

mrudge

(OK)

19.3 -- Bacula

Matt Rudge

mrudge

(OK)

20 - Virtualization

20.1 -- libvirt

(o)

20.2 -- JeOS and vmbuilder

(o)

20.3 -- UEC

(o)

(i) this sub-chapter will be removed

20.4 -- Openstack

Leonardo Borda

lborda

(OK)

(i) this is a new sub-chapter

20.5 -- LXC

Serge Hallyn

serge-hallyn

(OK)

(i) this is a new sub-chapter

21 - Clustering

21.1 -- DRBD

(o)

22 - VPN

22.1 -- OpenVPN

(o)

23 - Other Useful Applications

23.1 -- pam_motd

(o)

23.2 -- etckeeper

(o)

23.3 -- Byobu

(o)

23.4 -- References

(o)

A - Appendix

A.1 -- Reporting Bugs in Ubuntu Server Edition

(o)

Getting help

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

Deadline

All final merge proposals must be made by March 22, 2012, the string freeze date - explained here and seen here. It would be best to be one week ahead of this date as there might be some final touches required.

We have received a grace period of an extra week to get this done, so March 28.

Discussion

Here you can add your thoughts on

  • Re-organization of topics
  • Addition of missing topics: Juju
  • Anything else

Tables format well automatically in HTML, but not in PDF. Edits were done to the 4 tables to fix the PDF version while not effecting the HTML. This also eliminated table related warning messages during PDF generation. Also fixed bug 390935. See accepted mp+96904.

Text that crosses over a box boundary (typically <screen>) doesn't look good and can also be truncated and lost in the PDF version. Edits are in progress to fix. Estimate 3 or 4 Merge proposals total. See also Bugs: 510519, 674861 (duplicate), 680392. These edits also will reduce or eliminate border violation warnings during PDF generation. Status below in same format as above:

Box boundary issues

Part 1

Doug Smythies

dsmythies

(OK)

(i) Later portion of document. mp+96853

Part 2

Doug Smythies

dsmythies

(OK)

(i) Did some files not being edited by others (reduced violations from 58 to 43 and important ones from 28 to 13). Fixed new table in LXC for PDF

100%

Part 3

Doug Smythies

dsmythies

(OK)

(i) Important ones eliminated. 3 need to be left, but do not get truncated in PDF.

100%

Note 1: A large Merge Proposal by Lars Nooden was submitted, quite awhile ago, outside of this wiki. It conflicted with some edits within this wiki. The merge proposal is being broken into several smaller merge proposals and the conflicts are being resolved.

DocumentationTeam/SystemDocumentation/PreciseUbuntuServerGuide (last edited 2012-05-29 18:59:54 by petermatulis)