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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for backend.ai-webserver-21.3.9.tar.gz
Algorithm Hash digest
SHA256 cadcaa54711f9db3aa109c6f62b4edb77dcccec961b20128fa80ce0fb13e11c9
MD5 dd1917ccc8161888a7e8d9b2c8303f11
BLAKE2b-256 844dea4777d54152d626cbd750b15b0e15e358c49abb43428eafa0c0a753ec03

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for backend.ai_webserver-21.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 94ed508810e9cd845659a80029edd3b723679e230ee84edf6697269988ca5e73
MD5 fa2798c218493753d9e53dc5dec987d2
BLAKE2b-256 e2980c03dd022fbc56d221c2d974afe0f3e09c52fa74450965cd593d1259abe2

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