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

Uploaded Source

Built Distribution

backend.ai_webserver-24.3.2-py3-none-any.whl (13.0 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for backend.ai-webserver-24.3.2.tar.gz
Algorithm Hash digest
SHA256 ecb094159892f14125aabc31c2828b8f737a37a6b68c87ca38cb84efb76497cd
MD5 b86c479fb1819840ef20a6ac82717c17
BLAKE2b-256 365f7656d5886c61abb75dc571f74c9077a2420c07c4b1311e31d0f46bd500d0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 03e830b5a7f5c787f6fffa4fee3cfbb034b38df9bc34425c7664b88c1139ddd9
MD5 05fa6a92d309aaedf04897746c9bd67f
BLAKE2b-256 a56149bd29bcee0cf78fc664821b491793b216f7a1f911727ea32690e89da454

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