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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for backend.ai-webserver-24.3.0rc4.tar.gz
Algorithm Hash digest
SHA256 8d1417517932be29f20ebc06537cce170180083410786e82fe93f5e0316b5ecd
MD5 276f822d930a766fcd642e0f292ef3b7
BLAKE2b-256 73825cc7de187951522e83c4cedd4b07cb352c4eb9ad190e887792abbfdb5280

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.0rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 1d6a0cc27f8e4c6d684c4bcb7d9880240ce9ec630ce5e107e14a4fc6cfc13973
MD5 493c6e72ab788bd393dde6eeabdb2b63
BLAKE2b-256 fba872e2b70c620dff71354e32557ace87a4f0d7bef1e6927e420ac3667815d5

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