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

Uploaded Source

Built Distribution

backend.ai_webserver-24.3.9-py3-none-any.whl (17.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend_ai_webserver-24.3.9.tar.gz
  • Upload date:
  • Size: 16.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for backend_ai_webserver-24.3.9.tar.gz
Algorithm Hash digest
SHA256 02efa79a8441e5684faa102f49700c1003b2013b0fc7db7cd0f59453a707f590
MD5 84c237055b2a513d0602103383803956
BLAKE2b-256 141e4ae1be985533394dbfa37d0a6375cea41845db0b797a61f93e5111c4b8d3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2c20602f54234553fa83ef4aae4e6447dcacf1c9c344b4dc5978e381eb3c48fa
MD5 d0f541a527dbad5b3865735ccb77859d
BLAKE2b-256 b8a4e2c0fc7efe82a4b2badfe72b3ad26bb29e433b00644d86e45f07b8147837

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