Skip to main content

Backend.AI Web Server

Project description

Backend.AI Web Server

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

Uploaded Source

Built Distribution

backend.ai_webserver-21.3.5-py3-none-any.whl (6.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-21.3.5.tar.gz
  • Upload date:
  • Size: 6.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for backend.ai-webserver-21.3.5.tar.gz
Algorithm Hash digest
SHA256 0c122ffc2b79e074ea562b661cfe78b6bc7c4896a16249286092471707dece8d
MD5 c6fc865e57437890873e47573649d180
BLAKE2b-256 f11b66bee5dd050b7d48b884a6ec2dbf9c89ad4a9d3c0c9775645cfe0177c7b6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: backend.ai_webserver-21.3.5-py3-none-any.whl
  • Upload date:
  • Size: 6.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for backend.ai_webserver-21.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 24fe67f0f7dd512f7d9ce9e79557a4f159633d14069f81e16f1b47106cfaab02
MD5 55f61779ccf773394bae911e53bb343f
BLAKE2b-256 27c6769c4afb2c19c60e229f2bf5fe20e6908d4186ce229ca3644452ea668035

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