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-23.9.8rc1.tar.gz (12.5 MB view details)

Uploaded Source

Built Distribution

backend.ai_webserver-23.9.8rc1-py3-none-any.whl (12.7 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-23.9.8rc1.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-23.9.8rc1.tar.gz
Algorithm Hash digest
SHA256 dcaa7c7cd9d94247674dcf40fc5090be3c64587b5bb8cdd404456ab55a3db0bf
MD5 696d8614a421ef15ff9c7db27ea42a0d
BLAKE2b-256 9f353e34a8e68ffe1c0a513b9ed28f26ae6b8040763a25f2a87a4daccb06e07d

See more details on using hashes here.

Provenance

File details

Details for the file backend.ai_webserver-23.9.8rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for backend.ai_webserver-23.9.8rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 fccec9c9e258c21f6e35d543622cb452924d6cc12462a5ef9bf4174a18d220dc
MD5 4671ff1ce3bcfef530d15d29b114bce9
BLAKE2b-256 46d2e06b216eddee18c961ba5cf54bb80b40d65e802cc975b1317578a9cbecbd

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