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

Uploaded Source

Built Distribution

backend.ai_webserver-22.9.19-py3-none-any.whl (7.7 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-22.9.19.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-22.9.19.tar.gz
Algorithm Hash digest
SHA256 f8e5a34204ac2ec6716ec65a2aa61bda9e3fb17b1d9fa82a589f10059b4bc24c
MD5 7e41cb8d26c1270de657ed5c0eb36b84
BLAKE2b-256 6f1532dccd8771940df4cebaf6d620f8d8f05694c8f3b3e434aadedd28696439

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-22.9.19-py3-none-any.whl
Algorithm Hash digest
SHA256 e82bae47a563ce6a75da1415d9e3ce94eca16ca314e12ea537b74010f0978b1a
MD5 c8fcd4ab5d9c55c1638bd838f66430f6
BLAKE2b-256 6efe840dfe33cd81471f16025c6d5a707a434678f86610003d7282f351d4f75f

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