fix(docs): add server admin guide, cross-link with user guide
This commit is contained in:
parent
1b2618c0f7
commit
5d0aa60f1b
|
@ -0,0 +1,66 @@
|
|||
# Server Administration
|
||||
|
||||
This is the server administration guide for ONNX web.
|
||||
|
||||
Please see [the user guide](user-guide.md) for descriptions of the client and each of the parameters.
|
||||
|
||||
## Contents
|
||||
|
||||
- [Server Administration](#server-administration)
|
||||
- [Contents](#contents)
|
||||
- [Configuration](#configuration)
|
||||
- [Server Parameters](#server-parameters)
|
||||
- [Containers](#containers)
|
||||
- [CPU](#cpu)
|
||||
- [CUDA](#cuda)
|
||||
- [ROCm](#rocm)
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration is still very simple, loading models from a directory and parameters from a single JSON file.
|
||||
|
||||
### Server Parameters
|
||||
|
||||
You can limit the parameters in user requests to values within a reasonable range using the `params.json` file.
|
||||
|
||||
The keys share the same name as the query string parameter, and the format for each numeric value is:
|
||||
|
||||
```json
|
||||
{
|
||||
"default": 50,
|
||||
"min": 1,
|
||||
"max": 100,
|
||||
"step": 1
|
||||
}
|
||||
```
|
||||
|
||||
Setting the `step` to a decimal value between 0 and 1 will allow decimal inputs, but the client is hard-coded to send 2
|
||||
decimal places in the query and only some parameters are parsed as floats, so values below `0.01` will effect the GUI
|
||||
but not the output images, and some controls effectively force a step of `1`.
|
||||
|
||||
## Containers
|
||||
|
||||
### CPU
|
||||
|
||||
This is the simplest container to run and does not require any drivers or devices, but is also the slowest to
|
||||
generate images.
|
||||
|
||||
### CUDA
|
||||
|
||||
Requires CUDA container runtime and 11.x driver on the host.
|
||||
|
||||
### ROCm
|
||||
|
||||
Requires ROCm driver on the host.
|
||||
|
||||
Run with podman using:
|
||||
|
||||
```shell
|
||||
> TODO
|
||||
```
|
||||
|
||||
Rootless podman does not appear to work:
|
||||
|
||||
```none
|
||||
root is not video error
|
||||
```
|
|
@ -12,6 +12,8 @@ the model and accelerator being used for each image pipeline. Image parameters a
|
|||
and you can either upload or paint the mask for inpainting and outpainting. The last few output images are shown below
|
||||
the image controls, making it easy to refer back to previous parameters or save an image from earlier.
|
||||
|
||||
Please see [the server admin guide](server-admin.md) for details on how to configure and run the server.
|
||||
|
||||
## Contents
|
||||
|
||||
- [User Guide](#user-guide)
|
||||
|
|
Loading…
Reference in New Issue