Skip to main content

Backend.AI WebUI Host

Project description

Backend.AI Web Server

GitHub version PyPI version

A webapp hosting daemon which serves our webui as a SPA and proxies API requests

Installation

Prepare a Python virtualenv (Python 3.9 or higher) and a Redis server (6.2 or higher).

$ git clone https://github.com/lablup/backend.ai-webserver webserver
$ cd webserver
$ pip install -U -e .
$ cp webserver.sample.conf webserver.conf

Mode

If service.mode is set "webui" (the default), the webserver handles PWA-style fallbacks (e.g., serving index.html when there are no matching files for the requested URL path). The PWA must exclude /server and /func URL prefixes from its own routing to work with the webserver's web sessions and the API proxy.

If it is set "static", the webserver serves the static files as-is, without any fallbacks or hooking, while preserving the /server and /func prefixed URLs and their functionalities.

If you want to serve web UI in webserver with "webui" mode, prepare static web UI source by choosing one of the followings.

Option 1: Build web UI from source

Build backend.ai-webui and copy all files under build/bundle into the src/ai/backend/web/static directory.

Option 2: Use pre-built web UI

To download and deploy web UI from pre-built source, do the following:

git submodule init
git submodule update
cd src/ai/backend/web/static
git checkout main  # or target branch
git fetch
git pull

Setup configuration for webserver

You don't have to write config.toml for the web UI as this webserver auto-generates it on-the-fly.

Edit webserver.conf to match with your environment.

Usage

To execute web server, run command below. (for debugging, append a --debug flag)

$ python -m ai.backend.web.server

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backend.ai-webserver-22.9.0b4.tar.gz (6.6 MB view details)

Uploaded Source

Built Distribution

backend.ai_webserver-22.9.0b4-py3-none-any.whl (6.7 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-22.9.0b4.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-22.9.0b4.tar.gz
Algorithm Hash digest
SHA256 669e8949a77f3e10c99ec67a634487e81d126a50a75b08807436e75f8b7ba992
MD5 b84903a4cbf5a42c05c6bb631a8e7fb2
BLAKE2b-256 92a732bc4fd121a7ac9e1da2b649dba29769d75e968b76d90908db87ad67f56a

See more details on using hashes here.

Provenance

File details

Details for the file backend.ai_webserver-22.9.0b4-py3-none-any.whl.

File metadata

File hashes

Hashes for backend.ai_webserver-22.9.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 ec929494759a69e3439d2b815aaaaba87875d6f479e413f673a3af8546569f5b
MD5 e85e8e382e328b944f6e5acfd259ef84
BLAKE2b-256 c742a6c1be98f1ebf944c4523c73d29651cdfebca9771b594978f87a1cb4bd34

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page