Skip to main content

Backend.AI Web Server

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-21.9.0.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.3 CPython/3.9.7

File hashes

Hashes for backend.ai-webserver-21.9.0.tar.gz
Algorithm Hash digest
SHA256 ff2fe43fb18453bdb9000df8581c68609ed5ea27b691fdb98527417128d4f7e2
MD5 260bf0043ea4a1691b671d268711a243
BLAKE2b-256 2aec1413069d4682f84e5da1aed494aad7110fd4d9684bac40fe1aff86f7642a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: backend.ai_webserver-21.9.0-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.3 CPython/3.9.7

File hashes

Hashes for backend.ai_webserver-21.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a16fc2ed253162925b31f877f3bb0ee4369dd801ac5904163b386c89c466664a
MD5 8fc814e2ef00cfa5872f2e4d9107f730
BLAKE2b-256 72068fdfc5399be60d40f299cc6d385c9417bb0a8815ba0e0643df5d6ab961e7

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