Akan.js
Docs
Docs
Conventions
References
Cheatsheet
English
English
한국어
Akan.js
Akan.js v2 docs are now available.
View the v1 docs
Docs
Conventions
References
Cheatsheet
Released under the MIT License
Official Akan.js Consulting on
Akansoft
Copyright © 2026 Akan.js All rights reserved.
System managed by
bassman
Search docs
⌘ K
General
•
Authorization
•
Schema Design
•
Edge Computing
•
File Management
•
Single Sign-On
•
DataList & Enum
Interface
•
CRUD
•
Endpoint
•
Form
Observability
•
Logging
•
Dependency Injection
•
Error Handling
•
Metrics
Performance
•
Caching
•
Image Optimization
•
Lazy Loading
•
Querying
•
Queueing
•
Realtime
Development
•
Documentation
•
Script
•
Console
•
Docker
•
Kubernetes
•
PWA
Search docs
⌘ K
General
•
Authorization
•
Schema Design
•
Edge Computing
•
File Management
•
Single Sign-On
•
DataList & Enum
Interface
•
CRUD
•
Endpoint
•
Form
Observability
•
Logging
•
Dependency Injection
•
Error Handling
•
Metrics
Performance
•
Caching
•
Image Optimization
•
Lazy Loading
•
Querying
•
Queueing
•
Realtime
Development
•
Documentation
•
Script
•
Console
•
Docker
•
Kubernetes
•
PWA
Previous
Console
Next
Kubernetes
Docker
For a small edge server, start with one Akan app container.
Expose the app on port 8282. Route to service port 80.
Mount sqlite data so local data survives container restarts.
Mount logs so troubleshooting does not depend on container lifetime.
Minimal Compose
This is a simplified example for one app. Replace `myapp` and the image name with your app.
docker-compose.yaml
Open Console
`akan build` embeds `console.js` next to `main.js`, so you can open an operator console without creating files inside the container.
Set `AKAN_CONSOLE=1` only on the exec command for production-like environments.
Docker exec
Important Env
`AKAN_PUBLIC_OPERATION_MODE=edge`: tells the app it is running as an edge deployment.
`AKAN_SQLITE_DIR`: keeps sqlite files in a mounted folder.
`AKAN_LOG_DIR`: keeps runtime logs outside the container filesystem.
`AKAN_REPLICA`: controls child process roles for scaling.
Scale With AKAN_REPLICA
`AKAN_REPLICA` is a compact way to choose how many federation, batch, and all-purpose child processes the app starts.
Replica examples
Tips
Keep the first compose file boring. Add extra services only when the app really needs them.
Back up the sqlite volume before replacing edge hardware.
Check logs from the mounted folder when the container restarts repeatedly.
Docker
Minimal Compose
Open Console
Important Env
Scale With AKAN_REPLICA
Tips