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-24.3.7b1.tar.gz (13.1 MB view details)

Uploaded Source

Built Distribution

backend.ai_webserver-24.3.7b1-py3-none-any.whl (13.3 MB view details)

Uploaded Python 3

File details

Details for the file backend_ai_webserver-24.3.7b1.tar.gz.

File metadata

File hashes

Hashes for backend_ai_webserver-24.3.7b1.tar.gz
Algorithm Hash digest
SHA256 06635579ed245360662cb4745d027537627fcc383c12d7cdf1bed934db16ce64
MD5 554b5ad9c7730686edcbb0a13e26d6d7
BLAKE2b-256 bb0f51fe034e5469bccf1fc08a83e1e50a44b6d3d7c56d1c917aa7f1a818e6c9

See more details on using hashes here.

Provenance

File details

Details for the file backend.ai_webserver-24.3.7b1-py3-none-any.whl.

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.7b1-py3-none-any.whl
Algorithm Hash digest
SHA256 2328848d5aeaf01fd32f96029002182e99a967322cbdb0d45a95e6c58dc15bda
MD5 56cf67befe738087df9370c105b7df07
BLAKE2b-256 770c0d83b9e9375396032afa8222544b0fae706ba65254b973fe63e7eb48b92a

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