{"id":19674410,"url":"https://github.com/mirage/irmin-server","last_synced_at":"2025-04-29T01:31:15.350Z","repository":{"id":37796265,"uuid":"342401811","full_name":"mirage/irmin-server","owner":"mirage","description":"A high-performance server for Irmin","archived":false,"fork":false,"pushed_at":"2022-10-01T00:59:55.000Z","size":465,"stargazers_count":24,"open_issues_count":3,"forks_count":7,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-20T21:41:51.470Z","etag":null,"topics":["database","irmin","server"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mirage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-25T22:58:59.000Z","updated_at":"2025-02-19T10:12:14.000Z","dependencies_parsed_at":"2023-01-19T01:00:47.618Z","dependency_job_id":null,"html_url":"https://github.com/mirage/irmin-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirage%2Firmin-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirage%2Firmin-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirage%2Firmin-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirage%2Firmin-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mirage","download_url":"https://codeload.github.com/mirage/irmin-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251415733,"owners_count":21585882,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","irmin","server"],"created_at":"2024-11-11T17:18:13.814Z","updated_at":"2025-04-29T01:31:14.794Z","avatar_url":"https://github.com/mirage.png","language":"OCaml","funding_links":[],"categories":[],"sub_categories":[],"readme":"# irmin-server\n\nA server for [irmin](https://github.com/mirage/irmin) using a custom wire [protocol](#protocol), designed to have minimal overhead.\n\n## Command-line\n\n### Server\n\nTo run the server:\n\n```shell\n$ dune exec bin/server/server.exe -- --root ./data\n```\n\nRun the server with web-based dashboard on port 9999:\n\n```shell\n$ dune exec bin/server/server.exe -- --root ./data --dashboard 9999\n\nFor more information:\n\n```shell\n$ dune exec bin/server/server.exe -- --help\n```\n\n`irmin-server` accept `WebSocket` connection.\nTo run the server:\n\n```shell\n$ dune exec -- ./examples/server.exe --uri=ws://localhost:9090/ws\n```\n\n`irmin-server` can also be executed using `Docker`:\n\n```shell\n$ docker run --env PORT=9999 $(docker build -q .)\n```\n\n### Client\n\n`irmin-client` is a command-line application that can be used to send commands to `irmin-server`\n\nFor a list of available commands:\n\n```shell\n$ dune exec bin/client/client.exe -- --help\n```\n\nFor help with a specific command (for example, ping):\n\n```shell\n$ dune exec bin/client/client.exe -- ping --help\n```\n\n`irmin-client` can also send commands to `irmin-server` via WebSocket.\nTo run an example thats ping the server:\n\n```shell\n$ dune exec ./examples/ping.exe ws://localhost:9090/ws\n```\n\n## Browser\n\n### Server\n\n`irmin-server` accept `WebSocket` connection which makes communication from a browser possible.\nTo run the server:\n\n```shell\n$ dune exec -- ./examples/server.exe --uri=ws://localhost:9090/ws\n```\n\n### Client\n\n`irmin-client-jsoo` is a browser application that can be used to send commands to `irmin-server` via WebSocket    \n`cd` into examples/js\n\n```shell\n$ dune build\n```\n\nTo run an example thats ping the server from the browser:\nOpen the file `_build/default/examples/js/index.html` in the browser\n\n## OCaml client\n\nAn OCaml client library is provided to interact with the server. Some examples can be\nfound in the [examples/](/examples) directory.\n\n### Docs\n\nSee [src/irmin-client/client_intf.ml](/src/irmin-client/client_intf.ml)\n\n## Protocol\n\nA specification of the wire protocol can be found in [PROTOCOL.md](/PROTOCOL.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirage%2Firmin-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirage%2Firmin-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirage%2Firmin-server/lists"}