Backend.AI WebUI Host
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
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
Built Distribution
Hashes for backend_ai_webserver-24.3.8.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 69cc9ce029175a7c071674b8a548ff171879712d45f0c3712c58c549354528cb |
|
| MD5 | a2ebd354b7d9bd779d04b218adfa013e |
|
| BLAKE2b-256 | ab4419e59616ab1f8c661d6acb06166e77cbf16b879d435eff407e421afb1945 |
Hashes for backend.ai_webserver-24.3.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6e3ef45e3432059792c214a03ba6dd5a8a568b42ddb6e3cd6d69a91ca93239cb |
|
| MD5 | 836bf29626f5fe42b80215b352704917 |
|
| BLAKE2b-256 | 448777676772f1fd48bc770944bddf6c6f180abe3b65323104945ea856944899 |
