https://github.com/linbit/linstor-gui
HTML5 GUI frontend for LINSTOR
https://github.com/linbit/linstor-gui
Last synced: about 1 year ago
JSON representation
HTML5 GUI frontend for LINSTOR
- Host: GitHub
- URL: https://github.com/linbit/linstor-gui
- Owner: LINBIT
- License: gpl-3.0
- Created: 2024-09-12T07:47:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T09:19:02.000Z (about 1 year ago)
- Last Synced: 2025-04-18T22:47:14.434Z (about 1 year ago)
- Language: TypeScript
- Size: 3.96 MB
- Stars: 27
- Watchers: 8
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# LINSTOR GUI
[](https://opensource.org/) [](https://opensource.org/licenses/) [](https://linbit.com/linstor) [](https://github.com/LINBIT/linstor-gui) [](https://github.com/LINBIT/linstor-gui) [](https://www.linbit.com/support/) [](https://forums.linbit.com/c/linstor/6)
A web-based graphical user interface for LINBIT SDS (LINSTOR®, DRBD®, and related software).
## Description
`linstor-gui` is a web-based graphical user interface (GUI) for LINBIT SDS.
It provides a user-friendly way to create, manage, and monitor LINSTOR storage objects, such as storage pools, resource groups, resources, volumes, and snapshots.
`linstor-gui` communicates with the LINSTOR API to perform various operations, such as creating and deleting storage pools.
The GUI also provides a dashboard that displays information about the LINSTOR cluster, such as the status of nodes and volumes.
## Getting Started
### Installation on a LINSTOR controller node
This package does not have a standalone server; it requires the LINSTOR environment and serves files through the LINSTOR server. It should be installed on the machine running the LINSTOR controller. After installation, it can be accessed via a URL like `http://192.168.123.105:3370/ui/#!/`, replacing `192.168.123.105` with the IP address of your LINSTOR controller. Please choose your own Linux distribution, for Ubuntu and Debian:
```
sudo add-apt-repository ppa:linbit/linbit-drbd9-stack
sudo apt install linstor-gui
```
### Running in a Docker container
```
docker build -t linstor-gui .
docker run \
-p 8000:8000 \
-e LB_LINSTOR_API_HOST=http://192.168.123.105:3370 \
-e LB_GATEWAY_API_HOST=http://192.168.123.105:8080 \
linstor-gui
```
LB_LINSTOR_API_HOST is required, LB_GATEWAY_API_HOST is optional, default is `http://localhost:8080`.
### Running development mode on local machine(for developers)
- `npm install`
- Create a `.env` file in the root directory with the following variables:
```
# The hostname or IP address running the `linstor-gui` (optional)
VITE_HOST=127.0.0.1
# The port of the `linstor-gui` (optional)
VITE_PORT=8080
# The version of the `linstor-gui` (optional)
VITE_VERSION=DEV
# The host of the LINSTOR API
VITE_LINSTOR_API_HOST=http://192.168.123.214:3370
# The host of the LINSTOR GATEWAY API (optional)
VITE_GATEWAY_API_HOST=http://192.168.123.214:8080
# The host of the LINBIT VSAN API (optional)
VITE_VSAN_API_HOST=https://192.168.123.214
```
- `npm run start:dev`,
- Open your browser and navigate to `http://localhost:8080`
## Help
To report a problem with this software or to make a feature request, open an issue within this project.
For help developing or contributing to this software, contact the author.
For support using the software, you can seek help within the [LINBIT Community Forums](https://forums.linbit.com/).
Or as a LINBIT support customer, you can open a support ticket from your LINBIT customer account.
## Authors
- [Liang Li](mailto:liang.li@linbit.com)
## Contributions
Contributions are welcome! Either raise and Github issue if you find a bug or create a pull request if you have a fix or new feature.
## License
This project is licensed under the GPL-3.0 License - see the COPYING file for details
## Acknowledgments
LINSTOR GUI is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.