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.0rc3.tar.gz (12.7 MB view details)

Uploaded Source

Built Distribution

backend.ai_webserver-24.3.0rc3-py3-none-any.whl (12.9 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-24.3.0rc3.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-24.3.0rc3.tar.gz
Algorithm Hash digest
SHA256 20d1ac18938e4e31f2d9002ed2b337aaddf95c3e0461356e5c34cf893cb50fb7
MD5 5b3d9ede9348e24287f08016c7eb09ac
BLAKE2b-256 bdff55adb1f84d00be200d91092d0b0d8e21c2c139a06d622dfa88f762dc9ee7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 79ab7001921c8b34ff85642b08ba367b5c3b62240961b6d6b54973c94cd9faed
MD5 7f148722ceb4be765684a7eb4fe16f77
BLAKE2b-256 cc7bb94827612b7f196abaaa7d7110c98559d9d162ddcd0371a94f320a28b118

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