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:

cd src/ai/backend/web
curl --fail -sL https://github.com/lablup/backend.ai-webui/releases/download/v$TARGET_VERSION/backend.ai-webui-bundle-$TARGET_VERSION.zip > /tmp/bai-webui.zip
rm -rf static
mkdir static
cd static
unzip /tmp/bai-webui.zip

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-25.11.2.tar.gz (25.8 MB view details)

Uploaded Source

Built Distribution

backend_ai_webserver-25.11.2-py3-none-any.whl (26.5 MB view details)

Uploaded Python 3

File details

Details for the file backend_ai_webserver-25.11.2.tar.gz.

File metadata

  • Download URL: backend_ai_webserver-25.11.2.tar.gz
  • Upload date:
  • Size: 25.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for backend_ai_webserver-25.11.2.tar.gz
Algorithm Hash digest
SHA256 9c09ae1b19d9cdd0b6a16fa7e219d8d2fdc0bfa639efe71c74bbea008ce5a064
MD5 75544e46b9e9d1ddb0a5103da72e87b6
BLAKE2b-256 6644f219743aa89af29850810a23c0ca38570529814673ff7a30530eaa9c32c0

See more details on using hashes here.

File details

Details for the file backend_ai_webserver-25.11.2-py3-none-any.whl.

File metadata

File hashes

Hashes for backend_ai_webserver-25.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2045a4f257a17cac10da7462ec3c7821e7faff37badfcc3c6baa84e787100e1f
MD5 5d887502da6f158f526c09b609a5b8e4
BLAKE2b-256 1063c396a655afede2d914ce1fea11fd44df9dd397af1d2bf6157c4bfb281d27

See more details on using hashes here.

Supported by

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