Metadata-Version: 2.1
Name: backend.ai-webserver
Version: 22.3.9
Summary: Backend.AI WebUI Host
Home-page: https://github.com/lablup/backend.ai
Author: Lablup Inc. and contributors
License: LGPLv3
Project-URL: Documentation, https://docs.backend.ai/
Project-URL: Source, https://github.com/lablup/backend.ai
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Requires-Python: ==3.10.5
Description-Content-Type: text/markdown
Requires-Dist: Jinja2 (~=3.0.1)
Requires-Dist: aiohttp-cors (~=0.7)
Requires-Dist: aiohttp-session[aioredis] (~=2.11)
Requires-Dist: aiohttp (~=3.8.1)
Requires-Dist: aioredis[hiredis] (~=2.0.1)
Requires-Dist: aiotools (~=1.5.9)
Requires-Dist: backend.ai-cli (==22.03.9)
Requires-Dist: backend.ai-client (==22.03.9)
Requires-Dist: backend.ai-plugin (==22.03.9)
Requires-Dist: click (>=7.1.2)
Requires-Dist: coloredlogs (~=15.0)
Requires-Dist: pycryptodome (>=3.14.1)
Requires-Dist: setproctitle (~=1.2.2)
Requires-Dist: trafaret (~=2.1)
Requires-Dist: types-click
Requires-Dist: types-setuptools
Requires-Dist: types-toml
Requires-Dist: uvloop (>=0.16)
Requires-Dist: yarl (>=1.7)
Requires-Dist: toml (>=0.10.2) ; python_version <= "3.11"

# Backend.AI Web Server

[![GitHub version](https://badge.fury.io/gh/lablup%2Fbackend.ai-webserver.svg)](https://badge.fury.io/gh/lablup%2Fbackend.ai-webserver) [![PyPI version](https://badge.fury.io/py/backend.ai-webserver.svg)](https://badge.fury.io/py/backend.ai-webserver)

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).

```console
$ 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](https://github.com/lablup/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:

```console
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)


```console
$ python -m ai.backend.web.server
```


