https://github.com/vertex-center/vertex
Create your self-hosted lab in one click.
https://github.com/vertex-center/vertex
docker go golang hacktoberfest homelab raspberry-pi self-hosted vertex
Last synced: 5 months ago
JSON representation
Create your self-hosted lab in one click.
- Host: GitHub
- URL: https://github.com/vertex-center/vertex
- Owner: vertex-center
- License: mit
- Created: 2023-02-17T04:01:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T00:48:42.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T13:34:21.687Z (over 1 year ago)
- Topics: docker, go, golang, hacktoberfest, homelab, raspberry-pi, self-hosted, vertex
- Language: Go
- Homepage: https://docs.vertex.arra.red
- Size: 7.34 MB
- Stars: 30
- Watchers: 1
- Forks: 4
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Vertex
---
> [!WARNING]
> Vertex is currently in development. While it is usable, and I am using it in production, there may be breaking changes before the v1.0 release. You can keep following the project on [Discord](https://discord.gg/tGZV6X6ZJh), or by starring the repository.
---
## About
### Vertex
Vertex is a program that allows you to create your self-hosted server easily. Install, configure and start new services in less than a minute.
Vertex is designed to be installed on low-powered computers like Raspberry Pi, so prioritizing compiled languages like Go, Rust or C++.
## Features
- Install containers in one click from templates!
- Manage your containers easily (env, ports, etc)
- Receive alerts on Discord when a container is down
- Easy setup on Kubernetes with [Helm Charts](https://github.com/vertex-center/charts)
- _And more to come! (Database, Monitoring, etc)_
## Repository structure
The major part of the Vertex source code is organized as a monorepo.
- [client](https://github.com/vertex-center/vertex/tree/main/client): The web client.
- [docs](https://github.com/vertex-center/vertex/tree/main/docs): The documentation, hosted on [docs.vertex.arra.red](https://docs.vertex.arra.red/).
- [server](https://github.com/vertex-center/vertex/tree/main/server): The server of Vertex.
- [packages](https://github.com/vertex-center/vertex/tree/main/packages)
- [components](https://github.com/vertex-center/vertex/tree/main/packages/components): The shared UI components.
## Installation
> [!NOTE]
> Everything about the installation process is available in the [Vertex Documentation](https://docs.vertex.arra.red/).
Vertex can be installed easily using Docker. We provide three different infrastructure setups:
- **Bundle**: Includes all the services in a minimal number of containers. This is the recommended setup for small deployments.
- **Microservices**: A more complex setup that separates the services into different containers. This is the recommended setup for large deployments, if you want to scale the services independently, or if you want more reliability.
- **Development**: A setup for development purposes. This is the recommended setup if you want to contribute to the project.
### Method A - Bundle
1. Be sure to have [Docker](https://docs.docker.com/get-docker/) installed and running.
2. Download the [docker-compose.yml](https://github.com/vertex-center/vertex/blob/main/docker/docker-compose.yml) and the [setup_postgres.sh](https://github.com/vertex-center/vertex/blob/main/docker/multidb/setup_postgres.sh) files.
You should have the following directory structure:
```plaintext
docker-compose.yml
multidb/
setup_postgres.sh
```
3. In a terminal, in the same directory as the `docker-compose.yml` file, run the following command:
```bash
docker-compose up
```
4. Open [http://localhost:6133](http://localhost:6133) in your browser and start using Vertex!
### Method B - Microservices
1. Be sure to have [Docker](https://docs.docker.com/get-docker/) installed and running.
2. Download the [micro.docker-compose.yml](https://github.com/vertex-center/vertex/blob/main/docker/micro.docker-compose.yml) file.
3. In a terminal, in the same directory as the `micro.docker-compose.yml` file, run the following command:
```bash
docker-compose -f micro.docker-compose.yml up
```
4. Open [http://localhost:7518](http://localhost:7518) in your browser and start using Vertex!
### Method C - Install for development
1. Be sure to have [Docker](https://docs.docker.com/get-docker/) installed and running.
2. Clone the repository:
```bash
git clone https://github.com/vertex-center/vertex
cd vertex
```
3. Run the following command:
```bash
make run-dev
```
4. Open [http://localhost:5173](http://localhost:5173) in your browser and start using Vertex!
## License
[Vertex](https://github.com/vertex-center/vertex) is released under the [MIT License](./LICENSE.md).