Skip to content

Commit 90f57bf

Browse files
Merge pull request #891 from leancodepl/task/docs-docker-compose
Mention alternative docker compose quickstart method in docs
2 parents a04341e + 1f6686f commit 90f57bf

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

docs/quick_start/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ LeanCode CoreLibrary offers flexibility to suit different needs. Whether you wan
44

55
!!! Prerequisites info
66
Prior to proceeding with this tutorial, ensure you have the following requirements installed: [kubectl](https://kubernetes.io/docs/tasks/tools/),
7-
[K3D](https://k3d.io/#installation), [Helm](https://helm.sh/docs/intro/quickstart/), [Tilt](https://docs.tilt.dev/install.html), [Terraform](https://www.terraform.io/), [dotnet](https://dotnet.microsoft.com/en-us/download), [git](https://git-scm.com/).
7+
[K3D](https://k3d.io/#installation), [Docker](https://docs.docker.com/get-docker/), [Helm](https://helm.sh/docs/intro/quickstart/), [Tilt](https://docs.tilt.dev/install.html), [Terraform](https://www.terraform.io/), [dotnet](https://dotnet.microsoft.com/en-us/download), [git](https://git-scm.com/), and [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli).
8+
Azure CLI is required to access ACR with the provided certificates. If you want to use the Docker Compose based setup instead of the local Kubernetes cluster, make sure to have the Docker Compose plugin installed as well.
89

910
## Setting up the template
1011

@@ -143,3 +144,14 @@ tilt up projectname-integration_tests
143144
[Seq]: https://datalust.co/seq
144145
[SignalR]: https://dotnet.microsoft.com/en-us/apps/aspnet/signalr
145146
[Traefik]: https://traefik.io/traefik/
147+
148+
## Docker Compose
149+
150+
As an alternative to the local Kubernetes setup, `exampleapp` also ships Compose files in `backend/dev/compose`. Docker is still required for the default setup because K3D runs k3s inside Docker, but this path additionally requires the Compose plugin, which may be distributed separately (for example, as a distinct `docker-compose` package on Arch Linux). From a generated project, you can start that environment with:
151+
152+
```sh
153+
cd backend/dev/compose
154+
docker compose up
155+
```
156+
157+
The Compose Specification is not Docker-specific, so using Podman with `podman-compose` can work too, although it requires manual tweaks to the generated Compose files.

0 commit comments

Comments
 (0)