UbuntuServerDocumentation

Differences between revisions 5 and 6
⇤ ← Revision 5 as of 2007-09-11 15:43:52 →
Size: 1710
Editor: 202
Comment:
← Revision 6 as of 2007-09-25 14:27:45 → ⇥
Size: 2043
Editor: 202
Comment:
Deletions are marked like this. Additions are marked like this.
Line 36: Line 36:

== Current Server Guide ==

The following are notes on the existing server guide:

=== ServerGuide Wiki Page ===

https://wiki.ubuntu.com/ServerGuide

Update Release target to Gutsy Gibbon.

=== Chapter 1: Introduction ===

Comment on where to find HTML/PDF versions needs to be changed as
links go around in a loop.

Introduction

It struck me that on of the really nice things that would be good to have would be a set of consise manuals for how to set up a particular application (or set of applications) in a best practice manner.

  • Micro-manuals

These would be consise, step by step instructions for getting a particular service up and running and include details like the Ubuntu version and the version of the software that was used, and additional references.

The aim of the manuals would be to capture a significant amount of details to allow a suitable competent system administrator to know exactly how a system had been configured, should the service need to be upgraded or changed.

After following the instructions, the end user should have a system which as some service or feature now set up in a completely known state.

In addition, it would inform package maintainers, exectly how their software is being installed and used, and allow them to upgrade their software or packaging to minimise the amount of additional configuration required (eg. sensible defaults and minimum required configuration parameters.)

In this way, the "Micro-manual" for a particular task should evolve over time to be a very minimal document.

Contents

The following is a proposed 'standard' outline:

  • Introduction
    • Statement of purpose (what does this manual describe)
    • Required packages and versions
  • Instructions
  • Appendices
    • References

Examples

  • postfix with pam/ldap
  • Configuring mediawiki for an intranet site
    • Includes instructions for configuring local logo.
  • Setting up openVPN
  • Network print server
  • SMB File server

Current Server Guide

The following are notes on the existing server guide:

ServerGuide Wiki Page

https://wiki.ubuntu.com/ServerGuide

Update Release target to Gutsy Gibbon.

Chapter 1: Introduction

Comment on where to find HTML/PDF versions needs to be changed as links go around in a loop.

PaulSchulz/UbuntuServerDocumentation (last edited 2008-08-06 17:01:42 by localhost)