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.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fec043f09f9aa2d933d7f3944fb19ffcafe1d84c14e9e20f0150e8de47f7bb23 |
|
| MD5 | 858b8cdbec7d0b24a467353813beaea8 |
|
| BLAKE2b-256 | 9c9e2f383c27c79f96eccd1e0f01b62364fd3735adbab83c4eeeceff3dffdbe1 |
Hashes for backend.ai_webserver-24.3.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c85c94f9108cd87a0b78ea73ddd90b291e9cbc1b022e6079bddb690cdd2ab815 |
|
| MD5 | 92e3529bf2460b5c3920f9f7886121ef |
|
| BLAKE2b-256 | 9f8039f7c684793c7d29ff78f21096b452009ff9efd15338ec6e769bfee57500 |
