You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: Add Documentation for podman usage via TESSERACT_DOCKER_EXECUTABLE (#324)
#### Relevant issue or PR
Fixes#8
#### Description of changes
I did not document the usage of `--no-compose` as this will be
deprecated with the next release. Similarly, I removed the requirement
to install `docker-compose`.
#### Testing done
N/A
---------
Co-authored-by: Dion Häfner <dion.haefner@simulation.science>
Copy file name to clipboardExpand all lines: docs/content/introduction/installation.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,10 +26,9 @@ If the output is an empty table, that's okay! The CLI is functioning correctly,
26
26
[Docker Desktop](https://www.docker.com/products/docker-desktop/) ships with everything you need to run Tesseract Core, including the Docker Engine CLI, Docker Compose, and Docker Buildx. It also includes a GUI for managing containers and images.
27
27
It is available for Windows, macOS, and Linux for Debian and Fedora based distros.
28
28
29
-
If your system is not supported by Docker Desktop, or you prefer a more minimal setup, you will need to install the [`docker` engine CLI](https://docs.docker.com/engine/install/) together with some required plugins:
29
+
If your system is not supported by Docker Desktop, or you prefer a more minimal setup, you will need to install the [`docker` engine CLI](https://docs.docker.com/engine/install/) together with the following plug in:
To use Tesseract without `sudo`, you will need to add your user to the `docker` group. See [Linux post-installation steps for Docker Engine > Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user), or run:
35
34
@@ -43,6 +42,16 @@ Then, log out and back in to apply the changes.
43
42
Using `sudo tesseract` may bypass active virtual environments and shadow the `tesseract` command with [conflicting executables](#exe-conflicts). To avoid this, make sure you're using the correct `tesseract` executable, or add your user to the `docker` group (and omit `sudo`).
44
43
```
45
44
45
+
(installation-podman)=
46
+
## Using alternative container engines (such as podman)
47
+
48
+
The choice of container engine can be customised with the environment variable `TESSERACT_DOCKER_EXECUTABLE`. Tesseracts currently support container engines that have API's consistent with the `docker` CLI (e.g. `podman`). Assuming `podman` is already installed on your system and permissions are set up to allow running as a non-root user (typically the default), all that is required is to set the environment variable accordingly.
0 commit comments