diff --git a/docs/api/source/tools.docker.rst b/docs/api/source/tools.docker.rst deleted file mode 100644 index dc778362..00000000 --- a/docs/api/source/tools.docker.rst +++ /dev/null @@ -1,4 +0,0 @@ -Docker image builder -============================== - -Tools for generating a Docker image from a trame application \ No newline at end of file diff --git a/docs/api/source/tools.publish.rst b/docs/api/source/tools.publish.rst deleted file mode 100644 index cb0c4dc1..00000000 --- a/docs/api/source/tools.publish.rst +++ /dev/null @@ -1,4 +0,0 @@ -Cloud publish -================= - -Guide + tool to help quickly deploy a trame app into the cloud. \ No newline at end of file diff --git a/docs/api/source/tools.serve.rst b/docs/api/source/tools.serve.rst new file mode 100644 index 00000000..fa226ef7 --- /dev/null +++ b/docs/api/source/tools.serve.rst @@ -0,0 +1,23 @@ +Python serve utility +==================================== + +This executable allow you to run a trame application as a single process for multiple users. +As opposed to the regular launcher within our docker setup, this will run a single process +and execute each session within its own trame server as an asynchronous task in Python. + +This tools is not meant to be used on a production server but could be enough for multi-users demos. + +Also this assume that your trame application is using a class construct which expect a server as argument. + +The default example can be executed as follow: + +.. code-block:: bash + + python -m trame.tools.serve + +The possible arguments are: + - `--exec`: Trame app to serve (default: `trame.app.demo:Cone`) where `Cone`` is the class to instantiate from the `trame.app.demo` module. + - `--host`: IP or hostname to serve on (default: `localhost`) + - `--port`: Port to serve on (default: `8080`) + - `--ws-heart-beat`: WebSocket heart beat in seconds (default: `30`) + - `--ws-max-size`: WebSocket maximum message size in bytes (default: `10000000`) diff --git a/docs/api/source/tools.singularity.rst b/docs/api/source/tools.singularity.rst deleted file mode 100644 index ec9a251d..00000000 --- a/docs/api/source/tools.singularity.rst +++ /dev/null @@ -1,4 +0,0 @@ -Singularity image builder -============================== - -Tools for generating a singularity image from a trame application \ No newline at end of file