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:
cd src/ai/backend/web
curl --fail -sL https://github.com/lablup/backend.ai-webui/releases/download/v$TARGET_VERSION/backend.ai-webui-bundle-$TARGET_VERSION.zip > /tmp/bai-webui.zip
rm -rf static
mkdir static
cd static
unzip /tmp/bai-webui.zip
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
File details
Details for the file backend_ai_webserver-24.9.0.tar.gz.
File metadata
- Download URL: backend_ai_webserver-24.9.0.tar.gz
- Upload date:
- Size: 16.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 967b649f28e5dc8c3722e62a60cccbdc0a66791eb515a722aaf183305edb67d8 |
|
| MD5 | 1606d54cdac0b151bb73a34ed4e2013b |
|
| BLAKE2b-256 | 4fdfb73d8082bf853565a340a23c39c64de9ff42c0e3862b85026bf061cc342e |
File details
Details for the file backend.ai_webserver-24.9.0-py3-none-any.whl.
File metadata
- Download URL: backend.ai_webserver-24.9.0-py3-none-any.whl
- Upload date:
- Size: 17.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6613d1e4a155ff4448eaefd19a873715ca3785be122313f23d9f68ac87d0c4e0 |
|
| MD5 | 3fb71ba8016cb64a57e5c9995db4a26e |
|
| BLAKE2b-256 | 3032e3fa8129f84cf5609e3b0c2a59cf08597f2d7810f733f7fd62f4ca3a747b |
