https://github.com/mirage/irmin-server

A high-performance server for Irmin
https://github.com/mirage/irmin-server

database irmin server

Last synced: 4 days ago
JSON representation

A high-performance server for Irmin

• Host: GitHub
• URL: https://github.com/mirage/irmin-server
• Owner: mirage
• License: isc
• Created: 2021-02-25T22:58:59.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-01T00:59:55.000Z (about 2 years ago)
• Last Synced: 2024-05-09T23:25:57.387Z (6 months ago)
• Topics: database, irmin, server
• Language: OCaml
• Homepage:
• Size: 454 KB
• Stars: 24
• Watchers: 11
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# irmin-server

A server for [irmin](https://github.com/mirage/irmin) using a custom wire [protocol](#protocol), designed to have minimal overhead.

## Command-line

### Server

To run the server:

```shell

$ dune exec bin/server/server.exe -- --root ./data

```

Run the server with web-based dashboard on port 9999:

```shell

$ dune exec bin/server/server.exe -- --root ./data --dashboard 9999

For more information:

```shell

$ dune exec bin/server/server.exe -- --help

```

`irmin-server` accept `WebSocket` connection.

To run the server:

```shell

$ dune exec -- ./examples/server.exe --uri=ws://localhost:9090/ws

```

`irmin-server` can also be executed using `Docker`:

```shell

$ docker run --env PORT=9999 $(docker build -q .)

```

### Client

`irmin-client` is a command-line application that can be used to send commands to `irmin-server`

For a list of available commands:

```shell

$ dune exec bin/client/client.exe -- --help

```

For help with a specific command (for example, ping):

```shell

$ dune exec bin/client/client.exe -- ping --help

```

`irmin-client` can also send commands to `irmin-server` via WebSocket.

To run an example thats ping the server:

```shell

$ dune exec ./examples/ping.exe ws://localhost:9090/ws

```

## Browser

### Server

`irmin-server` accept `WebSocket` connection which makes communication from a browser possible.

To run the server:

```shell

$ dune exec -- ./examples/server.exe --uri=ws://localhost:9090/ws

```

### Client

`irmin-client-jsoo` is a browser application that can be used to send commands to `irmin-server` via WebSocket    

`cd` into examples/js

```shell

$ dune build

```

To run an example thats ping the server from the browser:

Open the file `_build/default/examples/js/index.html` in the browser

## OCaml client

An OCaml client library is provided to interact with the server. Some examples can be

found in the [examples/](/examples) directory.

### Docs

See [src/irmin-client/client_intf.ml](/src/irmin-client/client_intf.ml)

## Protocol

A specification of the wire protocol can be found in [PROTOCOL.md](/PROTOCOL.md)