{"id":19378837,"url":"https://github.com/linbit/linstor-gateway","last_synced_at":"2025-04-23T19:32:37.307Z","repository":{"id":49796873,"uuid":"203777837","full_name":"LINBIT/linstor-gateway","owner":"LINBIT","description":"Manages Highly-Available iSCSI targets, NVMe-oF targets, and NFS exports via LINSTOR","archived":false,"fork":false,"pushed_at":"2024-07-18T08:49:54.000Z","size":847,"stargazers_count":24,"open_issues_count":8,"forks_count":6,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-07-18T11:01:53.751Z","etag":null,"topics":["drbd","high-availability","iscsi","linstor","nfs","nvme-over-fabrics"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LINBIT.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-22T11:07:48.000Z","updated_at":"2024-07-18T08:48:41.000Z","dependencies_parsed_at":"2024-07-18T10:57:37.018Z","dependency_job_id":null,"html_url":"https://github.com/LINBIT/linstor-gateway","commit_stats":null,"previous_names":["linbit/linstor-iscsi"],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LINBIT%2Flinstor-gateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LINBIT%2Flinstor-gateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LINBIT%2Flinstor-gateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LINBIT%2Flinstor-gateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LINBIT","download_url":"https://codeload.github.com/LINBIT/linstor-gateway/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223932111,"owners_count":17227277,"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":["drbd","high-availability","iscsi","linstor","nfs","nvme-over-fabrics"],"created_at":"2024-11-10T09:07:34.073Z","updated_at":"2025-04-23T19:32:37.302Z","avatar_url":"https://github.com/LINBIT.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://linbit.com/linstor\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/LINBIT/linstor-gateway/master/docs/Linstor-Logo.png\" width=\"400\" alt=\"LINSTOR Logo\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n# LINSTOR Gateway\n\n\u003ca href=\"https://github.com/LINBIT/linstor-gateway/releases\"\u003e\u003cimg alt=\"GitHub release (latest SemVer)\" src=\"https://img.shields.io/github/v/release/LINBIT/linstor-gateway\"\u003e\u003c/a\u003e \u003ca href=\"https://github.com/LINBIT/linstor-gateway/blob/master/LICENSE\"\u003e\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/LINBIT/linstor-gateway\"\u003e\u003c/a\u003e \u003ca href=\"https://github.com/LINBIT/linstor-gateway/actions\"\u003e\u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/LINBIT/linstor-gateway/go.yml\"\u003e\u003c/a\u003e \u003ca href=\"https://join.slack.com/t/linbit-community/shared_invite/enQtOTg0MTEzOTA4ODY0LTFkZGY3ZjgzYjEzZmM2OGVmODJlMWI2MjlhMTg3M2UyOGFiOWMxMmI1MWM4Yjc0YzQzYWU0MjAzNGRmM2M5Y2Q\"\u003e\u003cimg alt=\"Slack Channel\" src=\"https://img.shields.io/badge/Slack-linbit--community-green\"/\u003e\u003c/a\u003e\n\nLINSTOR Gateway manages highly available **iSCSI targets**, **NFS exports**, and\n**NVMe-oF targets** by leveraging [LINSTOR](https://github.com/LINBIT/linstor-server)\nand [drbd-reactor](https://github.com/LINBIT/drbd-reactor).\n\n## Getting started\n\nRefer to the [_Understanding LINSTOR Gateway_](https://linbit.com/drbd-user-guide/linstorgateway-guide-1_0-en/) user guide which outlines some of the basic knowledge needed to effectively operate and administer a storage cluster that relies on LINSTOR Gateway.\nThis guide also provides some insight into the design decisions that were made while implementing LINSTOR Gateway, and gives an overview of how its internals work.\n\nFor a step-by-step tutorial on setting up a LINSTOR Gateway cluster, refer to\nthis blog post:\n[Create a Highly Available iSCSI Target Using LINSTOR Gateway](https://linbit.com/blog/create-a-highly-available-iscsi-target-using-linstor-gateway/).\n\n## Requirements\n\nLINSTOR Gateway provides a built-in health check that automatically tests whether all requirements are correctly met on\nthe current host.\n\nSimply enter the following command, and follow any suggestions that the command output might show:\n\n```\nlinstor-gateway check-health\n```\n\n## Documentation\n\nIf you want to learn more about LINSTOR Gateway, here are some pointers for further reading.\n\n### Command line\n\nHelp for the command line interface is available by running:\n\n```\nlinstor-gateway help\n```\n\nThe same information can also be browsed in Markdown format [here](./docs/md/linstor-gateway.md).\n\n### Configuration\n\nLINSTOR Gateway takes a configuration file. Refer to its documentation [here](./docs/config.md).\n\n### Internals\n\nThe LINSTOR Gateway command line client communicates with the server by using a REST API, which is\ndocumented [here](https://app.swaggerhub.com/apis-docs/Linstor/linstor-gateway/).\n\nIt also exposes a Go client for the REST\nAPI: \u003ca href=\"https://pkg.go.dev/github.com/LINBIT/linstor-gateway/client\"\u003e\u003cimg src=\"https://pkg.go.dev/badge/github.com/LINBIT/linstor-gateway/client.svg\" alt=\"Go Reference\"\u003e\u003c/a\u003e\n\n## Building\n\nIf you want to test the latest unstable version of LINSTOR Gateway, you can build the git version from sources:\n\n```\ngit clone https://github.com/LINBIT/linstor-gateway\ncd linstor-gateway\nmake\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinbit%2Flinstor-gateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinbit%2Flinstor-gateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinbit%2Flinstor-gateway/lists"}