Skip to content

Commit ef95708

Browse files
committed
Document basic requirements for Exoframe usage and OOM build issue, closes #70
1 parent 8aca4f0 commit ef95708

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/Basics.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@
55
- **Project** - one or more deployments grouped together (e.g. started via docker-compose)
66
- **Deployment** - one and only one deployed service
77

8+
## Requirements
9+
10+
Exoframe CLI is not particularly demanding and consumes at max ~50mb of RAM.
11+
Most intensive task from CLI side is packaging the project and streaming that to the server - it doesn't affect RAM usage that much and mostly relies on CPU and network.
12+
13+
Running Exoframe server on its own also doesn't require too much resources:
14+
- Exoframe Server consumes ~50mb of RAM
15+
- Traefik started along with server consumes ~60mb of RAM
16+
17+
Be aware though - execution of deployments will result in (1) new Docker images being built and (2) new Docker containers being started.
18+
Depending on your project's complexity, this might require significant amount of resources during both steps resulting in failed deployments (note: if Docker goes out-of-memory during build, you will not get any specific error - just a failed deployment).
19+
It is recommended to run Exoframe on a server with at least 1GB of RAM.
20+
821
### Commands
922

1023
| Command | Description |

0 commit comments

Comments
 (0)