Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions docs/deployment/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,36 @@ manual [installation packages](https://github.com/OpenAEV-Platform/openaev/relea

OpenAEV can be deployed using the *docker compose* command.

!!! tip "Podman as an alternative"

[Podman](https://podman.io/) is a drop-in replacement for Docker that does not require a daemon and can run containers rootless. Most `docker` and `docker compose` commands translate directly to `podman` and `podman compose` equivalents. If you prefer Podman or face [Docker Desktop licensing constraints](https://docs.docker.com/subscription/desktop-license/), you can substitute `podman` wherever `docker` is used in this guide.

### Pre-requisites

**:material-linux:{ .middle } Linux**

```bash
sudo apt install docker-compose
```
=== "Docker"

```bash
sudo apt install docker-compose
```

=== "Podman"

```bash
sudo apt install podman podman-compose
```

**:material-microsoft-windows:{ .middle } Windows and MacOS**

Just download the appropriate [Docker for Desktop](https://www.docker.com/products/docker-desktop) version for your
operating system.
=== "Docker"

Download the appropriate [Docker Desktop](https://www.docker.com/products/docker-desktop) version for your
operating system.

=== "Podman"

Download [Podman Desktop](https://podman-desktop.io/) for your operating system. Podman Desktop provides a graphical interface and manages the Podman machine automatically.

### Clone the repository

Expand Down Expand Up @@ -80,6 +98,10 @@ sudo systemctl start docker.service
docker compose up -d
```

!!! tip "Using Podman"

If you are using Podman, replace `docker compose` with `podman compose` and skip the `systemctl start docker.service` step (Podman does not require a daemon).

!!! success "Installation done"

You can now navigate to [http://localhost:8080](http://localhost:8080/) and log in with the credentials filled in your configuration.
Expand Down
4 changes: 4 additions & 0 deletions docs/development/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ cp ./openaev-api/src/main/resources/application.properties ./openaev-api/src/mai
Preconfigured containers for all the needed support containers (PostgreSQL, MinIO, RabbitMQ, Elasticsearch...)
can be found as a docker compose file in `./openaev/openaev-dev`.

!!! tip "Using Podman"

If you use [Podman](https://podman.io/) instead of Docker, replace `docker compose` with `podman compose` in the commands below. All compose files are fully compatible with Podman. See the [Ubuntu prerequisites](environment-ubuntu.md) for installation instructions.

Create a file a this location: `./openaev/openaev-dev/.env` and populate it with a minimal set of keys:
```shell
POSTGRES_USER=openaev
Expand Down
18 changes: 16 additions & 2 deletions docs/development/environment-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,21 @@
```shell
apt-get update && apt-get install git openjdk-21-jdk maven
```
* Docker Engine: follow the official instructions at [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/).
* A container runtime is required to run development dependency containers (PostgreSQL, MinIO, RabbitMQ, Elasticsearch). Install **one** of the following:

=== "Docker Engine"

Follow the official instructions at [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/).

=== "Podman"

[Podman](https://podman.io/) is a daemonless, rootless alternative to Docker. Most `docker` commands translate directly to `podman`.

```shell
apt-get update && apt-get install podman podman-compose
```

💡 Podman provides a Docker-compatible CLI. All `docker compose` commands used in the [build from source](build-from-source.md) guide can be replaced with `podman compose`.

## Frontend
* yarn via `apt-get`
Expand All @@ -22,4 +36,4 @@ Then install and set as default Node.js 22 (you should be able to use any versio
```shell
nvm install 22
nvm use 22
```
```