Skip to main content

Backend.AI WebUI Host

Reason this release was yanked:

Packaging issue that broke the basic usage

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

Uploaded Source

Built Distribution

backend.ai_webserver-22.3.5-py3-none-any.whl (5.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-22.3.5.tar.gz
  • Upload date:
  • Size: 5.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for backend.ai-webserver-22.3.5.tar.gz
Algorithm Hash digest
SHA256 c219ddfabefa86236e459a1d9a01ad328239d2ccba66e36517840487e2a11129
MD5 fcd39f9766e866d1ca19f2a1c133885a
BLAKE2b-256 0ea47d2c37f28533d8dc3405cc7a6515cf76d7512d1659b9a8a51ba3c74c10ea

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-22.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 350f9e8bab472c0d43657b15551ce9acea91208764a4c64f93b46b26be644afb
MD5 301a2b3bfa4951669fac536b6a473188
BLAKE2b-256 e016b590ecb53d0d6346e1e4f0ee090a21efcba8fd7d6e70fa7c7358add79647

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