Skip to content

Latest commit

 

History

History
116 lines (75 loc) · 4.84 KB

README.md

File metadata and controls

116 lines (75 loc) · 4.84 KB
Raw

Vertex logo

Vertex

GitHub release (latest by date) GitHub license GitHub contributors

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, 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++.

Vertex screenshot Vertex screenshot

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
  • And more to come! (Database, Monitoring, etc)

Repository structure

The major part of the Vertex source code is organized as a monorepo.

Installation

Note

Everything about the installation process is available in the Vertex Documentation.

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 installed and running.

  2. Download the docker-compose.yml and the setup_postgres.sh files.

    You should have the following directory structure:

    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:

    docker-compose up

  4. Open http://localhost:6133 in your browser and start using Vertex!

Method B - Microservices

  1. Be sure to have Docker installed and running.

  2. Download the micro.docker-compose.yml file.

  3. In a terminal, in the same directory as the micro.docker-compose.yml file, run the following command:

    docker-compose -f micro.docker-compose.yml up

  4. Open http://localhost:7518 in your browser and start using Vertex!

Method C - Install for development

  1. Be sure to have Docker installed and running.

  2. Clone the repository:

    git clone https://github.com/vertex-center/vertex
cd vertex

  3. Run the following command:

    make run-dev

  4. Open http://localhost:5173 in your browser and start using Vertex!

License

Vertex is released under the MIT License.