Skip to content

Installing Apps

oikapi applications are distributed as .oikapp packages — compressed archives containing table definitions, roles, permissions, business rules, and operation history.

The simplest way to install apps is from the marketplace, using @provider/name references:

Terminal window
oi app install @oikapi/crm # latest version
oi app install @oikapi/crm@1.0.0 # a specific version

These suites are published by the oikapi team:

AppDescription
CRMLeads, opportunity pipeline, and activities
SalesQuote-to-cash — quotes, orders, invoices, payments, subscriptions
ITSMIncidents, changes, problems, and a service catalog with SLAs
CMDBTyped configuration items, a dependency graph, and discovery-fed reconciliation
InventoryProducts, stock levels, movements, and physical counts
HR CoreEmployees, departments, the org-chart graph, leave, attendance, compensation
PurchasingVendor management, purchase orders, goods receipts, and vendor bills
ProjectsProjects, work items, dependencies, milestones, and time tracking
Event ManagementIngest monitoring events, deduplicate into alerts, and auto-raise incidents
DiscoveryScheduled refresh of CMDB items and relationships from a source
Accounting IntegrationsReceives GL postings from operational suites and syncs to an external accounting system

Many suites build on a shared spine — for example ITSM, Event Management, and Discovery rely on CMDB. Dependencies are resolved automatically and installed in the correct order.

You can also install from a local .oikapp package or a source directory:

Terminal window
oi app install ./crm-1.0.0.oikapp # pre-built package file
oi app install ./my-app # a source directory (built, then installed)
oi app install ./apps # all apps found under a directory
Terminal window
# Install and rename (fork as a customizable template)
oi app install @oikapi/crm --as my-crm
# Auto-approve cross-app access requests during install
oi app install @oikapi/itsm --auto-approve

When an app needs access to tables owned by another application, the installer records a cross-app access request. Pending requests are managed with oi access pending. Demo data is managed separately via oi app demo.

IncludedNot included
Table definitions and fieldsRecord data
RolesUser accounts
Permission grantsSession data
Business rules and scriptsRuntime state
Terminal window
oi app list

For full package install metadata (version, install time, who installed it, and signature verification status):

Terminal window
oi api GET /api/applications/installed

Packages can be signed with Ed25519 keys. Trust levels:

LevelMeaning
officialSigned by the oikapi team
verifiedSigned by a verified third-party developer
communitySigned by a community member
unsignedNo signature
Terminal window
oi app update crm # update an installed application
oi app uninstall crm # uninstall an application
oi app deps # show the dependency graph

If an application was previously deleted, installing the same package will restore it.

After installation, you can:

  • Add new fields to existing tables
  • Create additional tables in the same application
  • Modify permissions and roles
  • Add or edit business rules
  • Build custom web interfaces