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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-24.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 484747d4caaf702cca14bd7af3b2bb8382b70889fc5f0575c781b2815e883537
MD5 c70815e94854a70f2367bf5706e482d1
BLAKE2b-256 350315e61cf3a5a3ace525a95a217ae8f78aa76051a7f7f31852a44835da58e7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-24.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1ed1be8ca2f5b1d98449870658d7cd80cca304629b0568d8134b0802f1d0760c
MD5 c93d307afe9dbc445eb8bd1835d91458
BLAKE2b-256 68af9f2bc71b93ea736b97d8e7882975931b4a7c4260357611e6c5325c7fb4cb

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