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

Uploaded Source

Built Distribution

backend.ai_webserver-24.3.4rc1-py3-none-any.whl (13.4 MB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for backend.ai-webserver-24.3.4rc1.tar.gz
Algorithm Hash digest
SHA256 d2b9f76ebfc9001b634bdf948e5fd710eb06d01b35bd1e9e2480d00b8c0954a0
MD5 6628254298e47d6cdaa412cc1d4f5a5e
BLAKE2b-256 91d5685a0e133c70164b0deeeed1935c249a5834b4809568a5ffc611a4f6adeb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.4rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ec93e51a0839a02d1a2aa751e7a40b292192393f714f67b3361404c3fbf6d94
MD5 051add651bd1fb910f3c67d63f41ce47
BLAKE2b-256 dc17211be76bd89c7741e2ad3a068d735673701bc4143be2ebe74d7e40d13479

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