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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-21.3.14.tar.gz
  • Upload date:
  • Size: 6.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for backend.ai-webserver-21.3.14.tar.gz
Algorithm Hash digest
SHA256 f1cc93250428ca905a8a9fed1dcde308628dd9dafce783d22f800ca693b88ad8
MD5 d18b3d1c2d938e1f776db14efb11e8a6
BLAKE2b-256 677789aa6ac37e2d70dc3e1821eff6926c50e55d89974a63a4f8226b9f447afe

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: backend.ai_webserver-21.3.14-py3-none-any.whl
  • Upload date:
  • Size: 6.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for backend.ai_webserver-21.3.14-py3-none-any.whl
Algorithm Hash digest
SHA256 372a9820030d17dc64d9c518d3bf9bd9150a3d6e3c18b94a2280eaec41e6b8b5
MD5 848a96fad10b5ccee59c378cf46a887e
BLAKE2b-256 294c15e6260cc79226675f4d09dcb7b8837dd62835529191b8059d460892bf1d

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