Skip to main content

Backend.AI WebUI Host

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-23.3.0a3.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

backend.ai_webserver-23.3.0a3-py3-none-any.whl (6.5 MB view details)

Uploaded Python 3

File details

Details for the file backend.ai-webserver-23.3.0a3.tar.gz.

File metadata

File hashes

Hashes for backend.ai-webserver-23.3.0a3.tar.gz
Algorithm Hash digest
SHA256 3641bbaf5d1112c8be4cc07aef3673938bbfb6463f295b4b890a004393b24af1
MD5 2ab4854f433464c2007c2d0143d72991
BLAKE2b-256 5f74f0142b2528e7cc0feba6bf8cde2789b36151ae261d7da561272589fcf570

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for backend.ai_webserver-23.3.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 e271b322ba9c4dedb228fee96beac5583078aa5095576f648f8671529010bcff
MD5 c6f2d977c3318deafda2e88889860bbc
BLAKE2b-256 135444cf8ad0fb47107aa5306c4550e242c33d541ae245f875b7cbe23521d150

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