UbuntuServerGuideTemplate

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!

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. Update the % Complete column regularly.

Sub-chapter

Your name

Your Launchpad ID

Review

Extension

Comments

% Complete

1 - Introduction

1.1 -- Support

Hannie Dumoleyn

lafeber-dumoleyn

(./)

2 - Installation

2.1 -- Preparing to Install

(o)

2.2 -- Installing from CD

(o)

2.3 -- Upgrading

(o)

2.4 -- Advanced Installation

Hannie Dumoleyn

lafeber-dumoleyn

(./)

(i) bug #949146

3 - Package Management

3.1 -- Introduction

(o)

3.2 -- dpkg

Matt Rudge

mrudge

(./)

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

Elliot Still

elz89

(./)

(i) Right into it now..

4.2 -- TCP/IP

Alex Moldovan

alexmoldovan

Awesome! B)

4.3 -- Dynamic Host Configuration Protocol (DHCP)

Alex Moldovan

alexmoldovan

(./)

4.4 -- Time Synchronisation with NTP

(o)

X- Storage

X.1 -- LVM

Peter Petrakis

peter-petrakis

(o)

X.2 -- Software RAID (md)

Peter Petrakis

peter-petrakis

(o)

X.3 -- DM Multipath

Peter Petrakis

peter-petrakis

(./)

5- Remote Administration

5.1 -- OpenSSH Server

(o)

5.2 -- Puppet

(o)

6 - Network Authentication

6.1 -- OpenLDAP Server

Peter Matulis

petermatulis

(./)

6.2 -- Samba and LDAP

Peter Matulis

petermatulis

(./)

6.3 -- Kerberos

(o)

6.4 -- Kerberos and LDAP

(o)

7 - Domain Name Service (DNS)

7.1 -- Installation

(o)

7.2 -- Configuration

Doug Smythies

dsmythies

Warning /!\

(i) Small proposed changes

7.3 -- Troubleshooting

Doug Smythies

dsmythies

(OK)

(i) bug 864259

7.4 -- References

(o)

8 - Security

8.1 -- User Management

(o)

8.2 -- Console Security

(o)

8.3 -- Firewall

(o)

8.4 -- AppArmor

(o)

8.5 -- Certificates

(o)

8.6 -- eCryptfs

(o)

9 - Monitoring

9.1 -- Overview

(o)

9.2 -- Nagios

(o)

9.3 -- Munin

(o)

10 - Web Servers

10.1 -- HTTPD - Apache2 Web Server

(o)

10.2 -- PHP5 - Scripting Language

(o)

10.3 -- Squid - Proxy Server

(o)

10.4 -- Ruby on Rails

(o)

10.5 -- Apache Tomcat

(o)

11 - Databases

11.1 -- MySQL

(o)

11.2 -- PostgreSQL

(o)

12 - LAMP Applications

12.1 -- Overview

(o)

12.2 -- Moin Moin

GiuseppeTerrasi

giuseppeterrasi

Warning /!\

12.3 -- MediaWiki

(o)

12.4 -- phpMyAdmin

(o)

13 - File Servers

13.1 -- FTP Server

(o)

13.2 -- Network File System (NFS)

(o)

13.3 -- iSCSI Initiator

(o)

13.4 -- CUPS - Print Server

(o)

14 - Email Services

14.1 -- Postfix

(o)

14.2 -- Exim4

(o)

14.3 -- Dovecot Server

(o)

14.4 -- Mailman

(o)

14.5 -- Mail Filtering

(o)

15 - Chat Applications

15.1 -- Overview

(o)

15.2 -- IRC Server

(o)

15.3 -- Jabber Instant Messaging Server

(o)

16 - Version Control Systems

16.1 -- Bazaar

(o)

16.2 -- Subversion

(o)

16.3 -- CVS Server

(o)

16.4 -- References

(o)

17 - Windows Networking

17.1 -- Introduction

(o)

17.2 -- Samba File Server

(o)

17.3 -- Samba Print Server

(o)

17.4 -- Securing a Samba File and Print Server

(o)

17.5 -- Samba as a Domain Controller

(o)

17.6 -- Samba Active Directory Integration

(o)

18 - Backups

18.1 -- Shell Scripts

(o)

18.2 -- Archive Rotation

(o)

18.3 -- Bacula

(o)

19 - Virtualization

19.1 -- libvirt

(o)

19.2 -- JeOS and vmbuilder

(o)

19.3 -- UEC

(o)

(i) this sub-chapter should be renamed to 'Eucalyptus' i think

19.4 -- Openstack

Leonardo Borda

lborda

(o)

(i) this is a new sub-chapter

19.4 -- LXC

Serge Hallyn

serge-hallyn

(o)

(i) this is a new sub-chapter

20 - Clustering

20.1 -- DRBD

(o)

21 - VPN

21.1 -- OpenVPN

(o)

22 - Other Useful Applications

22.1 -- pam_motd

(o)

22.2 -- etckeeper

(o)

22.3 -- Byobu

(o)

22.4 -- References

(o)

A - Appendix

A.1 -- Reporting Bugs in Ubuntu Server Edition

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.

Discussion

Here you can add your thoughts on

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

  • Anything else

DocumentationTeam/SystemDocumentation/UbuntuServerGuideTemplate (last edited 2012-03-09 02:01:40 by petermatulis)