Aidbox
Aidbox.DevAidbox.CloudAidbox.OneFhirbase
Search…
Getting started
Getting Started
Installation & Configuration
Features
Licensing and Support
Versioning & Release Notes
FAQ
Aidbox configuration
Aidbox project
API constructor (alpha)
Setup SMTP provider
Zen Configuration
API
FHIR API
REST API
Bulk API
Batch Upsert
Batch/Transaction
ETAG support
Reactive API
Sequence API
Encryption API
Compartments API
GraphQL API
RPC API
Aidbox UI
Profiling and validation
Profiling and validation overview
Profiling with zen-lang
🎓
Write a custom zen profile
🎓
Extend an IG with a custom zen profile
Asynchronous resource validation
Profiling with AidboxProfile
Terminology
Aidbox terminology module overview
Import external (not-present) terminologies
Concept
CodeSystem
ValueSet
$translate on ConceptMap
Terminology Tutorials
FHIR Implementation Guides
🎓
HL7 FHIR Da Vinci PDex Plan Net IG
App development guides
Tutorials
Administration
Receive logs from your app
$matcho
$to-format
Security & Access Control
Overview
Authentication Flows
Access Control
Storage
Archiving
Database
AWS S3
GCP Cloud Storage
Azure Blob Storage
Core Modules
Entities & Attributes
$json-schema
Logging & Audit
Modules
HL7 v2 Integration
FHIR Resources
Custom Resources
Aidbox Search
First-Class Extensions
Plan API
Plan API Overview
Patient Access API
Tools
Mappings
Aidbox SDK
Contact us
Powered By GitBook
Aidbox project
Use zen-lang to configure Aidbox

Aidbox project

To start configuring Aidbox with zen-lang you need to create an Aidbox project.
Aidbox project is a directory with zen-lang edn files. Aidbox project can be shared with many Aidbox instances giving them the same configuration.

Load project using environment variables

Aidbox uses environment variables to load project.

AIDBOX_ZEN_PATHS

The AIDBOX_ZEN_PATHS environment variable is used to specify how Aidbox loads project.
Format:
1
AIDBOX_ZEN_PATHS=<source>:<format>:<path>[,<source>:<format>:<path>]*
Copied!
Source is either url or path. url is used to download Aidbox project from the remote location; path is used to load Aidbox project from the filesystem.
Format can be zip, dir or edn. Note that dir is only applicable to the path source.
Table of source and format compatibility:
source\format
zip
dir
edn
url
✓
​
✓
path
✓
✓
✓
Example:
1
AIDBOX_ZEN_PATHS=AIDBOX_ZEN_PATHS=url:zip:https://github.com/zen-lang/fhir/releases/download/0.2.13-1/hl7-fhir-us-core.zip
Copied!

AIDBOX_ZEN_LOAD

The AIDBOX_ZEN_LOAD environment variable is used to load a single namespace represented as edn.
Format:
1
AIDBOX_ZEN_LOAD=<zen-edn>
Copied!
Example:
1
AIDBOX_ZEN_LOAD='{ns my-zen-namespace import #{zen-proj1 zen-proj2 zen-proj3}}'
Copied!

AIDBOX_ENTRY_POINT

The AIDBOX_ENTRY_POINT environment variable specifies a zen namespace or a zen symbol. Aidbox starts reading its configuration from the entry point.
Format:
Using a zen namespace as an entry point:
1
AIDBOX_ENTRY_POINT=zen.namespace
Copied!
Using a zen symbol as an entry point:
1
AIDBOX_ENTRY_POINt=zen.namespace/zen-symbol
Copied!
Examples:
1
AIDBOX_ENTRY_POINT=aidbox-project1/dev-server
2
AIDBOX_ENTRY_POINT=aidbox-project2
Copied!

AIDBOX_ZEN_PROJECT

This environment variable will be merged with the AIDBOX_ZEN_PATHS.
The AIDBOX_ZEN_PROJECT environment variable is used to load Aidbox project from the path specified
Format:
1
AIDBOX_ZEN_PROJECT=<path>
Copied!

AIDBOX_ZEN_DEV_MODE

The AIDBOX_ZEN_DEV_MODE environment variable is used to enable the hot reloading of the aidbox project.
Format: if the variable is defined in the environment then Zen dev mode is enabled

Examples

You can see example using the Aidbox project and hot reload in the 🎓 Profiling with zen-lang tutorial.
Previous
FAQ
Next - Aidbox configuration
API constructor (alpha)
Last modified 1mo ago
Copy link
Contents
Aidbox project
Load project using environment variables
Examples