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

Uploaded Source

Built Distribution

backend.ai_webserver-20.9.9-py3-none-any.whl (6.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: backend.ai-webserver-20.9.9.tar.gz
  • Upload date:
  • Size: 5.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for backend.ai-webserver-20.9.9.tar.gz
Algorithm Hash digest
SHA256 498cb2ea83a8eba97adf4b3f7a3c0a46129bbeceb6a3e13813b1ec03b141416b
MD5 5bb427878c7249937f952c2af7f56eab
BLAKE2b-256 9f62a299887bb3b80e59c2c159355fbd66f6626a8b3ca1991702614944b53c0e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: backend.ai_webserver-20.9.9-py3-none-any.whl
  • Upload date:
  • Size: 6.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for backend.ai_webserver-20.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f681d3febe862d1b261b945d816e9cfb71874e8be363a10bb5a8e5bfe2ad0487
MD5 f3e981e2edd55ebd1195fcd625244a41
BLAKE2b-256 c841cef5b060ac213e40cb56d42526f4cd18553c6eeaff6fc36e421d1ed5ea94

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