Skip to main content

Backend.AI WebUI Host

Reason this release was yanked:

Shipped with invalid static webui bundle

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

Uploaded Source

Built Distribution

backend.ai_webserver-23.9.4-py3-none-any.whl (24.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-23.9.4.tar.gz
  • Upload date:
  • Size: 24.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for backend.ai-webserver-23.9.4.tar.gz
Algorithm Hash digest
SHA256 d7f00b96a398052a5f71474981753752c57762605fc670029f84773788bd02a6
MD5 0f25a82d2ffc6e8c415ce9533b265ca4
BLAKE2b-256 b27cf29572e2b4f195f8a4de8c3976368e27c72d74e989cad04d1eb1eeae7b55

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-23.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 66b63f557f2a2cf12d752723468ef72cd624d02209bf532d7e1363934ab15ca0
MD5 e3d4ce9c8e8b00537ceb45e23e123f3b
BLAKE2b-256 83cf11bcf974e5c436e7617795f16937973a629e9a6ad3542e19c1c8be37255f

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