Introduction

About Eenos Apps

Eenos apps are third party plugins for the Eenos control panel. This feature will help you to develop and manage custom apps for Eenos.

Eenos currently support two types of apps.

Python App : Apps developed using Django framework in Python
PHP App : Apps developed on PHP programming language.

You can develop the apps in python or php as you wish.

Directory Structure of Eenos Apps

Eenos apps have the following directory structure.

sampleapp/
├── app.conf
├── hooks
│ └── createacct
│ ├── post
│ │ └── sampleapp_post.sh
│ └── pre
│ └── sampleapp_pre.sh
├── LICENSE
├── post
│ └── 02-post.sh
├── pre
│ └── 01-ps.sh
├── rapp
│ └── sampleapp
│ ├── admin.py
│ ├── apps.py
│ ├── __init__.py
│ ├── migrations
│ │ └── __init__.py
│ ├── models.py
│ ├── templates
│ │ └── sampleapp_index.html
│ ├── tests.py
│ ├── urls.py
│ └── views.py
├── README
├── requirements.txt
├── scripts
│ ├── sampleapp_scripts1
│ ├── sampleapp_scripts.py
│ └── sampleapp_scripts.sh
├── static
│ └── sampleapp
│ ├── sampleapp.js
│ └── style.css
├── uapp
│ └── sampleapp
│ ├── admin.py
│ ├── apps.py
│ ├── __init__.py
│ ├── migrations
│ │ └── __init__.py
│ ├── models.py
│ ├── templates
│ │ └── sampleapp_index.html
│ ├── tests.py
│ ├── urls.py
│ └── views.py
├── vhosts
│ ├── rapp.sampleapp.conf
│ ├── uapp.sampleapp.conf
│ └── wap.sampleapp.conf
└── wap
└── sampleapp
├── admin.py
├── apps.py
├── __init__.py
├── migrations
│ └── __init__.py
├── models.py
├── templates
│ └── sampleapp_index.html
├── tests.py
├── urls.py
└── views.py

The detailed explanation of the dierctories and files are given below

app.conf

This file contain the configuration settings of app. It is a generic INI format file. Every Eenos app need this file. An Example configuration is given below:

[settings]
# All the settings fields are mandatory 
# The Name of the parent folder of the app.
# The name may contain letters, digits, hyphen and underscore
# The name always starts with a letter and a length of 20 characters.
name = sampleapp

# The menu name that will be showing inside the control panel pages
#  Maximum menu name length is 24 characters.
menu = A Sample App

# A description about the app. What is the use of this app ?
# Maximum length of description is 6o characters. 
description = This is a sample python app for testing purpose

# The programming language , currently support python or php only
# If this is a Python Django app use python
# if this is a  PHP app chose , php
# Accepted values [ python , php]
language = python

# This app version number
version = 1.0.0

# The version_check_url is a remote url shows the available current version of the app
# This url must give the version number as plain text output
# This version should ensure if the app is up-to-date
version_check_url =  https://download.eenos.com/apps/sample-python-app/version.txt

# The auto update script path used to update the scripts
# You can place this in ,/scripts/ folder so that will be installed 
auto_update = /usr/local/eenos/scripts/sampleapp_update

[wap]
# The general settings for WAP admin app
# To enable or disable this app in admin panel 
# Supported values ,[ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values [ off,  on] , default off
open_new_window = off

[rapp]
# The general settings for RAPP - Reseller control panel app
# To enable or disable this app in reseller  panel 
# Supported values ,[ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values, [ off,  on] , default off
open_new_window = off

[uapp]
# The general settings for UAPP - User control panel app
# To enable or disable this app in user  panel 
# Supported values, [ on , off ]
status = on

# If you wish to open the app in new browser window during a click action
# from the  control panel
# Supported values [ off,  on] , default off
open_new_window = off

This file have the following four sections:

Settings

This section contain the basic settings of the app. All fields are mandatory. The settings block have the following

name : The name of the app, it is the folder name of the app
menu : The menu name of the app.
description : A description about the app
language : The programming language used in the app. May be python or php.
version : The version number of the app.
version_check_url : A url to show the current version which will display the version as plain text format.
auto_update : A full path to update script. This script will be used to update the plugin