Developers Documentation

×

Warning

301 error for file:https://clearos.com/dokuwiki2/lib/exe/css.php?t=dokuwiki&tseed=82873f9c9a1f5784b951644363f20ef8

User Tools

Site Tools


Anatomy of an App

This document provides a technical review of a ClearOS app:

  • Where files are installed
  • Packaging information
  • Naming conventions

Naming Conventions

Every app has a simple basename that is used as a keyword across various systems. For example, the PPTP Server uses the basename pptpd.

SystemExample
Packagingapp-pptpd-6.1.0-1.v6.noarch.rpm
Bug TrackerList of issues
SVN/GITsvn.clearfoundation.com/clearos/webconfig/apps
TranslationsPPTP en français

… and many others.

File and Directory Locations

An app uses the traditional Linux file system layout, so you can find an app installed in the locations defined in the following table.

LocationTypePurpose
/etc/clearos/basenameFileSimple configuration file (optional)
/etc/clearos/basename.dDirectoryConfiglet files (optional)
/usr/clearos/apps/basename/DirectoryCore software, libraries and GUI (required)
/var/clearos/basenameDirectoryState files (optional)

Two Software Packages: Core Libraries and GUI

In many circumstances, a ClearOS app may need to use a library from another app. For example, the PPTP Server requires bits and pieces from the Samba library. For this reason, every app is packaged into two distinct RPMs:

  • app-basename-core: core libraries
  • app-basename: GUI frontend

When the PPTP Server is installed, it will pull in the app-samba-core library, but not the whole Samba GUI frontend.

content/en_us/dev_architecture_anatomy_of_an_app.txt · Last modified: 2015/03/03 11:07 (external edit)

https://clearos.com/dokuwiki2/lib/exe/indexer.php?id=content%3Aen_us%3Adev_architecture_anatomy_of_an_app&1531944573