YES Linux Administration Guide

Arthur Copeland

This document is Licensed under the GPL

Revision History
Revision $Revision: 1.2 $$Date: 2005/03/18 05:41:30 $$Author: boo $

1. Overview
2. Requirements
3. Design
3.1. Tabs
3.2. Categories
3.3. Applications
4. Manually Adding, Removing or Updating
5. Visually Adding, Removing or Updating
6. Conclusion

1. Overview

This document is a Guide on YES Linux Administration. In the guide you will be walked through the process of using the YES Linux Administration Application and how to manually extend the Application. The audience of this guide is any current User of YES Linux.

If help is ever needed please visit http://youresale.com/support/. You will find both commerical and free online support https://www.yeslinux.org/forum. The commercial support is provided by YEA (YourESale Authorized Administrators).

2. Requirements

YES Linux requirements:

  • A fully Installed and Configured instance of YES Linux

3. Design

The Administration Application is designed to allow extensibility, by allowing the Application to use and programming language. Natively the YES Linux Administration Application is built using PHP, but can integrate ANY application in ANY language as long as the application has a valid URL (ie website address). The Administration Application has 3 concepts that need to be understood to use and extend it those are Tabs, Categories, and Applications.

Users can either add, remove, disable, or update applications visually through the Application or by inserting values in the yesadmin database in the appropriate tables. The tables are named tab, category, and app with each table holding the respective concept.

3.1. Tabs

Tabs allow for sets of Categories to be logically grouped together, a tab can have 0 or more categories associated with it. Visually tabs are at the top of the page in it's own box, and during the application view in the top frame. Tabs are saparated by "|" pipes. Only one tab is displayed at a time and the active tab is not clickable and is displayed in black. Each tab has a display order, internal name, and a display title.

3.2. Categories

Categories allow for sets of Applications to be logically group together, a category can have 0 or more applications associated with it. Visually all categories associated with the current visible tab are displayed with a box around the whole category. Each category has a display order, internal name, and a display title. Categories are not visible in application mode.

3.3. Applications

Applications are the physical applications a user use, an application can only be associated with 1 category. Visually all applications are listed with the category they are associated with. When an application link is clicked on the administration application switches to the application mode. In application mode there are 2 frames the top frame displays all the tabs, with the bottom frame displaying the application. Each application has a display order, internal name, a display title, and a url.

4. Manually Adding, Removing or Updating

To manually add a new tab insert a row in the tab table.

To manually add a category, first you must have a tab to associate the category to. Once you have a tab insert a row in the category table and insert the id of the tab associated with the category.

To manually add an application, first you must have a category to associate the application to. Once you have a category insert a row in the app table and insert the id of the category associated with the app.

5. Visually Adding, Removing or Updating

To visually modify setting the user first need to enter the Administration Application Setup. To enter setup first got to /yesadmin, then click on the Application named "Administration Setup"

Once in "Setup" you can work with either tabs, categories, or applications. Select the concept to modify either tab, category, or application. Then fill out the appropriate form and save. Once it is saved the change is effective immediately.

6. Conclusion

For more information on General YES Linux Administration look here https://www.yeslinux.org/forum/index.php?c=7.