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

Uploaded Source

Built Distribution

backend.ai_webserver-23.9.10rc5-py3-none-any.whl (12.9 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-23.9.10rc5.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-23.9.10rc5.tar.gz
Algorithm Hash digest
SHA256 49a99fc9c4f18daf9b481e913a4528eb3d1b51757f0aec365a76d7917908272f
MD5 600df01cfd15065936506fd43d5b5e1a
BLAKE2b-256 d9260fde4bc935e4f60f9c2f7690d76fc50a8ac98360ea6cb04ae6cd44830cec

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-23.9.10rc5-py3-none-any.whl
Algorithm Hash digest
SHA256 dfb5fc83c12f02df0cebcba141eb0c996654c007065926025b14a907500c27fb
MD5 fe4184983126e371fcdcc530210bbf8e
BLAKE2b-256 b628a9ba92ae71e7eff2c9474bc0042f06927bd10fd5e5ec6ffcd77f6ec6bcda

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