Skip to Content
Browse documentation

App Package Structure

Organize Eenos app manifests, panel interfaces, static assets, lifecycle scripts, hooks and PHP vhost files for the current installer.

Use one top-level directory named for your app. The installer strips one archive path component, so app.conf must be directly inside that directory.

exampleapp/
├── app.conf
├── README
├── LICENSE
├── requirements.txt
├── wap/exampleapp/
├── rapp/exampleapp/
├── uapp/exampleapp/
├── static/exampleapp/
├── pre/
├── post/
├── scripts/
├── hooks/
└── vhosts/

Only include executable components you actually need. The three panel sections still belong in app.conf, even when some interfaces are disabled or absent.

Source and destination mapping

Package pathInstalled destination or behavior
app.confParsed into /var/eenos/apps/<appname>.yaml.
wap/<appname>/Python: /usr/local/eenos/wap/<appname>/; PHP: /usr/local/eenos/3rdparty/apps/wap/<appname>/.
rapp/<appname>/Python: /usr/local/eenos/rapp/<appname>/; PHP: /usr/local/eenos/3rdparty/apps/rapp/<appname>/.
uapp/<appname>/Python: /usr/local/eenos/uapp/<appname>/; PHP: /usr/local/eenos/3rdparty/apps/uapp/<appname>/.
static/<appname>/Copied for enabled interfaces: WAP's public/static/default/<appname>/; RAPP/UAPP's existing public/static/<theme>/<appname>/ directories.
scripts/*Top-level regular files copied into /usr/local/eenos/scripts/. Nested script directories are not recursively installed by this step.
hooks/<event>/<phase>/...Installed into /var/eenos/hooks/ and recorded for removal. Use the supported event/phase structure.
vhosts/<panel>.<appname>.confMatching files copied into /usr/local/eenos/etc/eenosd/; use the plural vhosts/ directory.
requirements.txtNonempty file passed to the installed Eenos Python pip; dependencies affect the shared environment.
pre/*, post/*Top-level regular files executed during installation, before and after deployment respectively.

The panel file and static-copy steps run for interfaces enabled at installation time. Enabling a previously disabled interface later does not copy missing code or assets from an old archive.

Naming

Choose a unique lowercase Python-compatible identifier such as exampleapp for both languages. It avoids import and route ambiguity and keeps all paths consistent. The current settings validator accepts more names than Python can import cleanly; a hyphenated name is unsuitable for the Django package.

The old examples mention a 20-character name, 24-character menu and 60-character description. The current validator does not enforce those maximum lengths. Keep labels concise for the sidebar, but do not rely on those comments as validation rules.

Prefix script, hook and template filenames with your app name. They can share destination directories with other apps, so generic filenames risk collisions and later removal of another app's resources.