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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-22.3.4.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.4.tar.gz
Algorithm Hash digest
SHA256 711b8ed7ccf86adb8d8a237939a1ba417569e5a7bf9f9ae8cbe0f5ed21a3c1c0
MD5 11a5e3a8ec03a88a4c7d6697646b4b9c
BLAKE2b-256 70d383f688a70999bb179ce67866fc8bcd2ce268e176b8543c45e221a41a040b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-22.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1d7673bed2b5d0e5f06a7fdf82c02331fb41e247497ffada00adeb73868ac08e
MD5 32bd6121d46fc9ba7244cb4f47d9133e
BLAKE2b-256 964d92ea23d018180bffc07ce0bb7f15a6dc14fc4e2c2e97795c412c6777cc3b

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