Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ardem authored Oct 18, 2024
1 parent 09ad9c5 commit cc6afe9
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,25 @@
# Ylem
The open-source data streaming platform is a one-stop-shop solution for orchestrating data streams on top of Apache Kafka, Amazon SQS, Google Pub/Sub, RabbitMQ, various APIs, and data storages.

# Dependencies
<img width="1158" alt="Screenshot 2024-10-18 at 13 20 37" src="https://github.com/user-attachments/assets/fee384d3-bc10-4681-a3d7-a8a9f5dc8983">

To be able to run Ylem locally, the following dependencies need to be installed and configured.
# Installation

## 1. Docker 4
## 1. Install and configure dependencies

To run Ylem, the following dependencies must be first installed and configured.

### Docker 4

If you don't yet have Docker 4 installed, [install](https://www.docker.com/products/docker-desktop/) it from their official website for your OS.

## 2. Install Apache Kafka
### Apache Kafka

Ylem uses Apache Kafka to process pipelines and tasks. [Install](https://kafka.apache.org/) it from their official website or skip this step if you already have it installed.

We also recommend installing the Apache Kafka GUI software of your choice to manage its topics and subscriptions.
We also recommend that you install the Apache Kafka GUI software to manage its topics and subscriptions.

## 3. Create Kafka topics
### Create Kafka topics

To be able to work correctly, Ylem requires the following Apache Kafka topics to be created:

Expand All @@ -41,21 +45,17 @@ To be able to work correctly, Ylem requires the following Apache Kafka topics to
* query_task_run_results
* notification_task_run_results

# How to start with Docker
## 2. Install from pre-build containers

## Start all containers
The best way to install Ylem is to clone the repository https://github.com/ylem-co/ylem-installer and run `docker compose up` or `docker compose up -d` from it. It will install Ylem from the latest version of pre-build containers stored on Docker Hub.

``` bash
docker compose up
```
## Or build and install from the source

or
If you want to compile Ylem from the source, run `docker compose up` or `docker compose up -d` from this repository. It will compile the code and run all the necessary containers.

``` bash
docker compose up -d
```
### To rebuild a particular container

## Rebuild a particular container
If you want to rebuild a particular container locally, run:

``` bash
docker compose build --no-cache %%CONTAINER_NAME%%
Expand All @@ -67,6 +67,10 @@ E.g.
docker compose build --no-cache ylem_users
```

### Using .env files

Some particular integrations might require extra steps and using `.env` files. More information is in [our documentation](https://docs.ylem.co/open-source-edition/configuring-integrations-with-.env-variables).

# Folder structure in this repository

Ylem is a set of microservices. Each microservice is represented by one or more containers in the same network and communicates with each other via the API.
Expand Down

0 comments on commit cc6afe9

Please sign in to comment.