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-23.3.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0137c9ac51d7c0fb595f4b746681831c8fa737c49465f64b184b2599a55307c5 |
|
MD5 | 9c1590ed394d3021d34d0f9a496e390c |
|
BLAKE2b-256 | cb4ae4d02dd45addcd1a300afceb01b2ae53acbf41fd14d525ac16e03b7165a2 |
Hashes for backend.ai_webserver-23.3.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 167e71fa18b8911cbf1d2a970b4161c47e3b34e2bf9fe559709a2e92c8a8a2c6 |
|
MD5 | 941398517c67d43ad86987604a3ec0a4 |
|
BLAKE2b-256 | 75b4091aad760948918dcf0d7eb693082383fcfd658c0fab606cf74c2fedbad8 |