aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Christopher Baklid <[email protected]>2018-05-28 14:29:43 +0200
committerGravatar Christopher Baklid <[email protected]>2018-05-28 14:29:43 +0200
commit6ce1c8966d2d5ed4342ff59271c212a898c9ddfa (patch)
treeef16676d2d9342a07d5542ec85b9bf4e9e0aa43a
parentrun as non-priv user in snekbox (diff)
readme diagram
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 90a0a6c..d1802b5 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,21 @@ Python sandbox runners for executing code in isolation aka snekbox
The user sends a piece of python code to a snekbox, the snekbox executes the code and sends the result back to the users.
```
-user ->
- website ->
- <- websocket ->
- <- webserver ->
- <- rabbitmq ->
- <- snekbox ->
- <- <executes python code>
+ +-------------+ +------------+ +-----------+
+ | |---------->| |-------->| | >-------+
+input-> | WEBSERVER | websocket | RABBITMQ | AMQP | SNEKBOX | output |
+ | |<----------| |<--------| | <-------+
+ +-------------+ +------------+ +-----------+
+ ^ ^ ^
+ | | |- Executes python code
+ | | |- Returns result
+ | | +-----------------------
+ | |
+ | |- Messaging queues opens on demand and closes automatically
+ | +-----------------------------------------------------------
+ |
+ |- Uses websockets for asynchronous connection between webui and webserver
+ +-------------------------------------------------------------------------
```