Skip to main content

Backend.AI Web Server

Project description

backend.ai-webserver

A minimal webapp to convert web session requests to API requests.

Installation

Prepare a Python virtualenv (Python 3.7 or higher) and a Redis server (5.0 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-20.9.18.tar.gz (6.6 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-20.9.18.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-20.9.18.tar.gz
Algorithm Hash digest
SHA256 06490d69eaebaec18d4ed6dd668f98d2b87673c69a997bab7530a5e5a1c69170
MD5 c5d57c8b352d2a2f55e5eccf7eb5905c
BLAKE2b-256 69d6a04be9b843fd0fbaa8ad2dbbdd6d6813f0ad4baff1733afece5a1adbe720

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: backend.ai_webserver-20.9.18-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-20.9.18-py3-none-any.whl
Algorithm Hash digest
SHA256 5906c0e347eb227ad5bb9aa950a319cc1b59d2394d5e06f2f21376ee21e0c2c0
MD5 c5fbe2295e57c46673e226aad0d60b64
BLAKE2b-256 4e62cd0d3fddd43fa25ed0b6337f8f2562325f75fc93ccd80917e027eda8fa87

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