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
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
Built Distribution
Hashes for backend.ai-webserver-22.9.22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35b3e5f8d205b9322a14a70593e7007b19fcdbba51b61bd357556cf1eb5fb22f |
|
MD5 | 10ef9b42d7711d82efbcc3d1b507c70c |
|
BLAKE2b-256 | 4ef9bf3ddf2bb09368395d6983df26c156bf549f7720d78d2ed12204ec21e42b |
Hashes for backend.ai_webserver-22.9.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 279e23284881456a223922b80239999cc28277843c2da4078ab4dc2ab963ad33 |
|
MD5 | 0f1e7dc5d7487e70b671be264f684e3a |
|
BLAKE2b-256 | b18da0c1daf2c362dbb8b5acacf408c8d7bd1223cfe7c7c1e14d54a34037fc96 |