Skip to content

rebootoio/vaxiin-server

Repository files navigation

Vaxiin Server

Server side component of the Vaxiin framework
Explore the docs »

Report Bug · Request Feature

Overview

Vaxiin is an autonomous zombie recovery machine.

Or in more technical terms

Vaxiin is an out-of-band automation framework allowing for:

  • failure detection
  • remote state extraction
  • human and machine recovery emulation
  • vendor-agnostic automation

Quick Start Guide

To view a demo and get started quickly, follow the guide at the sandbox repository

Components

Component Repoistory Artifact Documentation
Server GitHub DockerHub Docs
Agent GitHub DockerHub Docs
CLI GitHub Release Docs

Running

Default Configuration

To run the server with default configuration and the database in the current directory:

docker run -d -v $(pwd):/db rebooto/vaxiin-server

Custom configuration

Download the sample configuration file locally

wget https://raw.githubusercontent.com/rebootoio/vaxiin-server/main/config-example.yaml -O config.yaml

Edit the file, change configuration if needed and run the server

docker run -d -v $(pwd):/db -v $(pwd)/config.yaml:/etc/vaxiin-server-config/config.yaml rebooto/vaxiin-server

Additional information about the available configuration can be found in the docs.

Builiding

The docker image can be built by cloning this repository and running make build

Contributing

Contributions are what make the Open Source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated!

If you have a suggestion that would make this better, please fork the repo and create a Pull Request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the AGPL-3.0 License License.

Contact

Join the Rebooto Discord Server

Open an issue

About

Server side component of the vaxiin framework

Resources

License

Stars

Watchers

Forks

Languages