SME Server:Documentation:Developers Manual

From SME Server
Revision as of 03:40, 23 February 2007 by Snoble (talk | contribs) (links to chapters, [page numbers may break when regenerated])
Jump to navigation Jump to search

Developer Documentation

This manual is aimed at developers and provides the information they require to integrate their applications into the SME Server platform. The manual discusses the key concepts of the SME Server such as the configuration database, configuration file templates and the events and actions model which differentiate the SME Server from other Linux distributions.

The Developer manual is maintained separate to this wiki, corrections and suggestions are to be made on the Bug Tracker.

Developer Manual Booklet (All the chapters on one page .html)

Also available as a one page .pdf

1. An overview of the SME Server

  • About this manual
  • Who should read this manual?
  • What is the SME Server?
  • Design philosophy
  • Architecture overview

2. SME Server internals

  • Configuration database
  • Actions and events
  • Configuration file templates
  • Process startup, supervision and shutdown
  • The server-manager web interface

3. How to create an SME Server package - step by step

  • Getting started
  • Getting to know how to customize the SME Server
  • Packaging your application
  • The SME Server development environment

4. Advanced customization of the SME Server

  • Advanced customization principles

5. Documentation and resources

  • Perl modules

Documentation Links

Other sources of information

 -Managing Software with Yum - http://mirror.centos.org/centos/4/docs/html/yum/
 -CentOS 4/RHEL4 Documentation - http://mirror.centos.org/centos/4/docs/
 -Fedora Documentation - http://fedora.redhat.com/docs/
 -Fedora Developers Guide - http://fedora.redhat.com/docs/developers-guide/
 -Fedora Documentaion Guide - http://fedora.redhat.com/docs/documentation-guide/
 -Maximum RPM Book - http://www.rpm.org/max-rpm-snapshot/
 -Fedora RPM Guide (draft) - http://fedora.redhat.com/docs/drafts/rpm-guide-en/
 -Fedora Wiki - Building Packages Guide - http://fedoraproject.org/wiki/Docs/Drafts/BuildingPackagesGuide
 -Mezzanine Howto - --www.kainx.org/mezzanine/mezz-howto.txt-- also http://lists.contribs.org/mailman/public/devinfo/msg08010.html
 -Fedoraproject.org RPM Packaging Guidelines - http://fedoraproject.org/wiki/PackagingGuidelines
 -Fedoraproject.org Package Review Guidelines - http://fedoraproject.org/wiki/PackageReviewGuidelines
 -Fedoraproject.org RPM Spec File Scriptlet Snippets - http://fedoraproject.org/wiki/ScriptletSnippets 


Translations

SME Server Supports English, French, German, Spanish and Italian. Other Languages are in progress [Bug tracker - translations]

A Manual Translation is available in German http://sudemo.info/wiki


Adding new Languages

To translate the server-manager, There is one file per server-manager panel, plus a few others.

To translate to another language

* Raise a bug in the bug tracker to let us know you're starting or add to a work in progress

Information from these link needs to be imported here: http://forums.contribs.org/index.php?topic=30780.0 http://forums.contribs.org/index.php?topic=29298.0