Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 3.99 KB

README.md

File metadata and controls

80 lines (58 loc) · 3.99 KB
Raw

VivumLab

Issues Forks Stars License pre-commit

Everyone has heard about 3rd party companies and data protection... tl;dr, you don't really know who has access to your data, and you don't really know what they're doing with it.

Haven't considered this? take a moment and give it some thought.. What's the big deal about other people having your data? Villanova University, in Pennsylvania, has a good article here

The alternative is self-hosting, and VivumLab can help. VivumLab deploys web services to a linux server. Deployment is managed by Ansible, the services are managed by Docker. VivumLab provides a WebUI for ease of use.

Including over 130 services; VivumLab wants to make it easy for everyone to run their own services and own all their data in an easy and secure way, with minimal reliance, or intervention from cloud or service providers.

tl;dr: Getting started..

  1. get an old computer
  2. attach a monitor and a keyboard
  3. plug the computer into your modem/router
  4. install a linux distribution of your choice. Need help deciding? Here is a quick google search to get you started
  5. Run VivumLab. Easy.

Quick Installation:

Before you begin:

  • Install WSL (Windows Only)
  • Install Docker
  • Install git (if you want to use the VivumLab git commands)

Either:

  • download the archive as a zip file (and unzip it) OR
  • Clone the VivumLab git (default: dev branch)

git clone https://GitHub.com/VivumLab/VivumLab.git

  • On Windows:

    • Open a command prompt
    • navigate to downloaded VivumLab folder
    • run Bash launch.sh

  • On MacOS/Linux:

    • Open a terminal
    • navigate to downloaded VivumLab folder
    • Run ./launch.sh

Note: the launch.sh file, will add the current user (if you don't use sudo) to the docker group, for ease of use, later.

Features

  • Runs in docker container, or locally on a Linux or MacOS machine
  • Easy to use UI, that runs in a browser (No Javascript required), easy to learn.
  • Encrypted user configuration files
  • Automated HTTPS via LetsEncrypt
  • Optional Cloud Bastion Server with WireGuard VPN
  • Optional Service Access via Tor network. Information here

Coming soon

  • Automated Settings Sync via git

  • Automated Backups

  • Easy Restore via Restic

  • Tutorial / Demo Podcast

  • Check out other planned features here

Documentation

Available for your viewing pleasure here VivumLab allows a user to deploy their own set of documentation (useful if the VivumLab server is setup to remain within your local network). See the docs for more information.

Available Services

You can view the complete list of available software here

Get Support

Give Support

Help to fix or extend the code, by contributing. An easy and rewarding way to help others get back their data.

You may even be able to join the official 'Contributor' team. (Talk to the VivumLab Core team, for more information).