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

Uploaded Source

Built Distribution

backend.ai_webserver-22.9.1-py3-none-any.whl (6.5 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for backend.ai-webserver-22.9.1.tar.gz
Algorithm Hash digest
SHA256 8b1dbcc058b01b32c8bdb430406d8005b4ea8b07c4ded37b61ca28cb5172d73f
MD5 b99cfb679698ee3d8c304082d00b58c0
BLAKE2b-256 66ecf8dc6e1e0cbe8eda22f12570aa9dbc4f099414daf46b730d17287d714934

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-22.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1ddd5c0ed666e7cf93075e19f0ca25ac205286b59a83a5fe38cebf2d34aca578
MD5 6e50f9b8bec3a2b61907a171b5c7cf2f
BLAKE2b-256 2a2d51aebb07ad28171fb7156d38f9f9b84a4237991b39d9e6627620b6289452

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