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-24.3.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21244155b1a2da70bc276dfc50d0e02b4d8f1c0a8507a1cd92d14324e98b9dfb |
|
MD5 | 18223fed4e300c5e24103b1500a2e4ad |
|
BLAKE2b-256 | 206fbc072aba20fbf5b70648a9bb10d05af5b97470f656eb88485c0cc3183ff1 |
Hashes for backend.ai_webserver-24.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d89455888d6d7efa9c0a11fca4ff62e19dc85fbf4ac0e0c825b41bfba52023e |
|
MD5 | 8aa323fa53d97115ae3a2a91d62e8fef |
|
BLAKE2b-256 | afc27266a98646f25d0e90d90c857f6ff5b0998760bc510fcbba6721d3913edf |