Skip to content
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.

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

add horaemeta compile guide #154

Merged
merged 2 commits into from
Nov 5, 2024
Merged
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
22 changes: 20 additions & 2 deletions content/en/docs/dev/compile_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ source $HOME/.cargo/env

# Compile and Run

Compile HoraeDB by the following command:
## horaedb-server

Compile horaedb-server by the following command in project root directory:

```
cargo build
```

Then you can run HoraeDB using the default configuration file provided in the codebase.
Then you can run it using the default configuration file provided in the codebase.

```bash
./target/debug/horaedb-server --config ./docs/minimal.toml
Expand Down Expand Up @@ -77,3 +79,19 @@ To fix those, you should adjust ulimit as follows:
ulimit -n unlimited
ulimit -f unlimited
```

## horaemeta-server

Building horaemeta-server require Golang version >= 1.21, please [install it](https://go.dev/doc/install) before compile.

Then in `horaemeta` directory, execute:

```bash
go build -o bin/horaemeta-server ./cmd/horaemeta-server/main.go
```

Then you can run horaemeta-server like this:

```bash
bin/horaemeta-server
```