mvoCI

README

mvoCI

My Very Own CI-server (Continuous Integration), a personal continuous integration system. mvoCI builds code from git repositories either on user-input, via an API call or on webhooks, i.e. whenever someone pushed commits to the git or when new releases are added.

mvoCI aims to be simple and do as much as is necessary and nothing more. It aims to have a small memory footprint, be easy to use and understand.

It is intended as a personal continuous integration server, useful for your private builds or builds of a team, who know and trust each other. It is not intended to be used for the public, for untrusted repositories or with untrusted co-users.

Be advised, that mvoCI uses shell access for its building routines. It is your responsibility to secure your machine from damage or data leakage by mvoCI.

What it does

• organize Repositories and Builds of them
• build Repositories on webhook or on click "Build Now"
• build and publish release-artifacts to Gitea automatically
• bindings to Gogs, Gitea, Gitbucket, Gitlab, Bitbucket and Github

What it does not

• Anything more, like
  • timed builds
  • after build scripts
  • SVN, Mercurial, VCS (although there should not be a real reason for this constraint)
  • internationalization (only English)

Building

Go mod takes care of dependencies. Just run the following for building mvoCI, and place it together with the necessary assets inside the dist-folder.

make dist

Requirements

Database

You need a database server, or use SQLite as database backend. You may use one of the following:

• PostgreSQL
• MySQL / MariaDB
• SQLServer
• SQLite3

Set up

• ./mvo --install for the installation dialogues
• ./mvo for production mode

Configuration and Usage

mvo.cfg

Config-file in JSON-format. See core/config.go.

Lock down

Do not execute mvoCI as root. It should be used with as little permissions as possible, but enough to be useful for your usecase. Most builds execute untrusted code like automake scripts, Makefiles or the like - make sure, that this untrusted code cannot leak information from your system.

systemd

You may use this script to start mvoCI automatically as an own user (e.g. mvo). Please make sure, that that user cannot do anything you wouldn't do yourself!

[Unit]
Description=mvoCI
After=syslog.target
After=network.target
After=mysqld.service
#After=postgresql.service

[Service]
RestartSec=2s
Type=simple
User=mvo
Group=mvo
WorkingDirectory=/home/mvo
ExecStart=/home/mvo/mvo
Restart=always
Environment=USER=mvo HOME=/home/mvo

[Install]
WantedBy=multi-user.target

Contribute

Feel free to contribute to mvoCI if there are features missing for your use case. Either send me write-up for your use case, then I'll evaluate if it is inline with my goals of mvoCI. Feel also free to send pull-requests or patches my way.

If you want to start, try adding new routes in web/routing.go, then fill the new route with content and a template in views/. You can also have a look in the REST-API (web/api.go) code and add new functions there, which might be useful or add new hook-code for other git-version control systems (hooks/).

Project Structure

• main.go - start point, reads config, starts builders, hands control to echo
• core/ - database, configuration, logging. Fundamental stuff.
• build/ - build workers and starting of builds from the web-side.
• web/ - routing "table" for echo, handlers for requests, most of them called by echo
• hook/ - webhook-request definitions for parsing the requests more or less generically (see web/hook.go)

Documentation

Overview

mvoCI is a simple continuous integration server aimed at personal use. You really should not use it as an open CI server and only provide it to people and code you trust. mvoCI does not isolate build-processes well, if you need that, please choose a different solution.

mvoCI aims to be simple and easy to use, not a lot of features, just enough to build simple projects and maybe deploy them to your server fo example. It is not equipped with distributed building atm (while you of course could script that in the build script).

Be aware, mvoCI lets you shoot of your foot. Don't.