mirror of
https://github.com/ilya-zlobintsev/LACT.git
synced 2026-08-17 16:34:54 -05:00
chore: add documentation for docker image
This commit is contained in:
@@ -71,10 +71,7 @@ The service can also be used standalone with a config file, for example in headl
|
||||
[Copr repository](https://copr.fedorainfracloud.org/coprs/ilyaz/LACT/), or
|
||||
download an RPM from
|
||||
[releases](https://github.com/ilya-zlobintsev/LACT/releases/).
|
||||
- Bazzite: Use the Flatpak below.
|
||||
|
||||
This helper installs the Flatpak version and automatically adds the AMD
|
||||
overclocking boot option.
|
||||
- Bazzite/Fedora Atomic: Use the Flatpak.
|
||||
- Gentoo: Available in
|
||||
[GURU](https://github.com/gentoo/guru/tree/master/sys-apps/lact).
|
||||
- OpenSUSE: an RPM is available in
|
||||
@@ -83,10 +80,11 @@ The service can also be used standalone with a config file, for example in headl
|
||||
Only tumbleweed is supported as leap does not have the required dependencies
|
||||
in the repos.
|
||||
- NixOS: There is a package available in
|
||||
[nixpkgs](https://search.nixos.org/packages?channel=24.05&from=0&size=50&sort=relevance&type=packages&query=lact)
|
||||
[nixpkgs](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=lact).
|
||||
- Flatpak (universal): Available on [Flathub](https://flathub.org/apps/io.github.ilya_zlobintsev.LACT) and in [releases](https://github.com/ilya-zlobintsev/LACT/releases/).
|
||||
|
||||
See the [Flatpak documentation](./flatpak/README.md) for setup notes.
|
||||
See the [Flatpak documentation](./flatpak/README.md) for additional notes.
|
||||
- Docker (service only, no GUI): See [DOCKER.md](./docs/DOCKER.md)
|
||||
- Build from source.
|
||||
|
||||
Note: Nvidia support requires the Nvidia proprietary driver with CUDA libraries
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
# Docker
|
||||
|
||||
LACT is available as a Docker image on [GHCR](https://github.com/ilya-zlobintsev/LACT/pkgs/container/lact).
|
||||
|
||||
This image only contains the daemon and CLI, it does not have a GUI.
|
||||
The intended use case is for servers and headless systems, for example as a [metrics exporter](./EXPORTER.md).
|
||||
|
||||
# Usage
|
||||
|
||||
Basic usage:
|
||||
```
|
||||
docker run -d --name lact --privileged -v ./config:/etc/lact -v /dev/dri:/dev/dri ghcr.io/ilya-zlobintsev/lact:master
|
||||
```
|
||||
|
||||
To call the CLI, use `docker exec`:
|
||||
```
|
||||
docker exec lact lact cli info
|
||||
```
|
||||
|
||||
You can set GPU configuration options by editing `config.yaml` in the config dir mounted into the container.
|
||||
|
||||
# Nvidia
|
||||
|
||||
The image contains Nvidia support, but additional setup is needed to expose Nvidia GPUs through Docker.
|
||||
Please check Nvidia's container documentation for how to set it up.
|
||||
|
||||
TODO: add nvidia command example
|
||||
Reference in New Issue
Block a user