UbuntuServerGuide

Revision 154 as of 2012-09-18 13:06:34

Clear message

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.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 6.1 if you're not reviewing 6.1).

1. Get the repository

sudo apt-get install bzr docbook docbook-xsl xsltproc libxml2-utils yelp-tools
mkdir ~/sguide-1210
cd ~/sguide-1210
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-html

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

The stuff in green is the priority this cycle (Quantal).

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

(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)

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

(o)

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)

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 -- 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

(o)

19.2 -- Archive Rotation

(o)

19.3 -- Bacula

(o)

20 - Virtualization

20.1 -- libvirt

George Dunlap

dunlapg

(./)

Testing and integrating Xen

5%

20.2 -- JeOS and vmbuilder

(o)

20.3 -- UEC

(o)

(i) this sub-chapter will be removed

20.4 -- Openstack

(o)

20.5 -- LXC

(o)

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.