Skip to content

docs: update quickstart docs #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HeadHunter483 merged 1 commit into from
Sep 14, 2025
Merged

docs: update quickstart docs #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions docs/en/01-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ curl --request POST \

seq-ui is a backend for user interface.

To launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, config.seq-ui.yaml:
To launch seq-db with seq-ui you need to add minimal configuration file for seq-ui, [config.seq-ui.yaml](https://github.com/ozontech/seq-db/blob/main/quickstart/config.seq-ui.yaml):

```yaml
server:
Expand Down Expand Up @@ -186,7 +186,7 @@ mapping:
path: auto
```

And then launch using this minimal docker compose example:
And then launch using this minimal [docker compose example](https://github.com/ozontech/seq-db/blob/main/quickstart/docker-compose.seq-ui.yaml):

```yaml
services:
Expand All @@ -200,6 +200,11 @@ services:
- "5556:5556" # Default gRPC port
- "5557:5557" # Default debug port
command: --config config.yaml

seq-ui-fe:
image: ghcr.io/ozontech/seq-ui-fe:latest
ports:
- "5173:80"

seq-db-proxy:
image: ghcr.io/ozontech/seq-db:latest
Expand Down
9 changes: 7 additions & 2 deletions docs/ru/01-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ curl --request POST \

seq-ui это бэкенд для пользовательского интерфейса.

Чтобы запустить seq-db в связке с seq-ui, нужно создать файл конфигурации для seq-ui, config.seq-ui.yaml:
Чтобы запустить seq-db в связке с seq-ui, нужно создать файл конфигурации для seq-ui, [config.seq-ui.yaml](https://github.com/ozontech/seq-db/blob/main/quickstart/config.seq-ui.yaml):

```yaml
server:
Expand Down Expand Up @@ -183,7 +183,7 @@ mapping:
path: auto
```

Далее нужно запустить этот docker compose пример:
Далее нужно запустить этот [docker compose пример](https://github.com/ozontech/seq-db/blob/main/quickstart/docker-compose.seq-ui.yaml):

```yaml
services:
Expand All @@ -198,6 +198,11 @@ services:
- "5557:5557" # Default debug port
command: --config config.yaml

seq-ui-fe:
image: ghcr.io/ozontech/seq-ui-fe:latest
ports:
- "5173:80"

seq-db-proxy:
image: ghcr.io/ozontech/seq-db:latest
volumes:
Expand Down
Loading