github.com/alloyci/alloy-runner@v1.0.1-0.20180222164613-925503ccafd6/docs/README.md (about)

     1  # AlloyCI Runner
     2  
     3  [![Build Status](https://gitlab.com/AlloyCI/alloy-runner/badges/master/build.svg)](https://github.com/AlloyCI/alloy-runner)
     4  
     5  AlloyCI Runner is the open source project that is used to run your jobs and
     6  send the results back to AlloyCI.
     7  ## Requirements
     8  
     9  AlloyCI Runner is written in [Go][golang] and can be run as a single binary, no
    10  language specific requirements are needed.
    11  
    12  It is designed to run on the GNU/Linux, macOS, and Windows operating systems.
    13  Other operating systems will probably work as long as you can compile a Go
    14  binary on them.
    15  
    16  ## Features
    17  
    18  - Allows to run:
    19   - multiple jobs concurrently
    20   - use multiple tokens with multiple server (even per-project)
    21   - limit number of concurrent jobs per-token
    22  - Jobs can be run:
    23   - locally
    24   - using Docker containers
    25   - using Docker containers and executing job over SSH
    26   - using Docker containers with autoscaling on different clouds and virtualization hypervisors
    27   - connecting to remote SSH server
    28  - Is written in Go and distributed as single binary without any other requirements
    29  - Supports Bash, Windows Batch and Windows PowerShell
    30  - Works on GNU/Linux, OS X and Windows (pretty much anywhere you can run Docker)
    31  - Allows to customize the job running environment
    32  - Automatic configuration reload without restart
    33  - Easy to use setup with support for Docker, Docker-SSH, Parallels or SSH running environments
    34  - Enables caching of Docker containers
    35  - Easy installation as a service for GNU/Linux, OSX and Windows
    36  - Embedded Prometheus metrics HTTP server
    37  
    38  ## [Install AlloyCI Runner](install/README.md)
    39  
    40  AlloyCI Runner can be installed and used on GNU/Linux, macOS, FreeBSD and Windows.
    41  You can install it using Docker, download the binary manually or use the
    42  repository for rpm/deb packages that AlloyCI offers. Below you can find
    43  information on the different installation methods:
    44  
    45  - [Install using AlloyCI's repository for Debian/Ubuntu/CentOS/RedHat (preferred)](install/linux-repository.md)
    46  - [Install on GNU/Linux manually (advanced)](install/linux-manually.md)
    47  - [Install on macOS (preferred)](install/osx.md)
    48  - [Install on Windows (preferred)](install/windows.md)
    49  - [Install as a Docker Service](install/docker.md)
    50  - [Install in Auto-scaling mode using Docker machine](install/autoscaling.md)
    51  - [Install on FreeBSD](install/freebsd.md)
    52  - [Install on Kubernetes](install/kubernetes.md)
    53  - [Install the nightly binary manually (development)](install/bleeding-edge.md)
    54  
    55  ## [Register AlloyCI Runner](register/README.md)
    56  
    57  Once AlloyCI Runner is installed, you need to register it with AlloyCI.
    58  
    59  Learn how to [register a AlloyCI Runner](register/README.md).
    60  
    61  ## Using AlloyCI Runner
    62  
    63  - [See the commands documentation](commands/README.md)
    64  
    65  ## [Selecting the executor](executors/README.md)
    66  
    67  AlloyCI Runner implements a number of executors that can be used to run your
    68  builds in different scenarios. If you are not sure what to select, read the
    69  [I am not sure](executors/README.md#i-am-not-sure) section.
    70  Visit the [compatibility chart](executors/README.md#compatibility-chart) to find
    71  out what features each executor supports and what not.
    72  
    73  To jump into the specific documentation of each executor, visit:
    74  
    75  - [Shell](executors/shell.md)
    76  - [Docker](executors/docker.md)
    77  - [Docker Machine and Docker Machine SSH (auto-scaling)](install/autoscaling.md)
    78  - [Parallels](executors/parallels.md)
    79  - [VirtualBox](executors/virtualbox.md)
    80  - [SSH](executors/ssh.md)
    81  - [Kubernetes](executors/kubernetes.md)
    82  
    83  ## [Advanced Configuration](configuration/index.md)
    84  
    85  - [Advanced configuration options](configuration/advanced-configuration.md) Learn how to use the [TOML][] configuration file that AlloyCI Runner uses.
    86  - [Use self-signed certificates](configuration/tls-self-signed.md) Configure certificates that are used to verify TLS peer when connecting to the AlloyCI server.
    87  - [Auto-scaling using Docker machine](configuration/autoscale.md) Execute jobs on machines that are created on demand using Docker machine.
    88  - [Autoscaling AlloyCI Runner on AWS](configuration/runner_autoscale_aws/index.md)
    89  - [Supported shells](shells/README.md) Learn what shell script generators are supported that allow to execute builds on different systems.
    90  - [Security considerations](security/index.md) Be aware of potential security implications when running your jobs with AlloyCI Runner.
    91  - [Runner monitoring](monitoring/README.md) Learn how to monitor Runner's behavior.
    92  - [Cleanup the Docker images automatically](https://alloy.com/alloy-org/alloy-runner-docker-cleanup) A simple Docker application that automatically garbage collects the AlloyCI Runner caches and images when running low on disk space.
    93  
    94  ## Troubleshooting
    95  
    96  Read the [FAQ](faq/README.md) for troubleshooting common issues.
    97  
    98  ## Changelog
    99  
   100  Visit [Changelog] to view recent changes.
   101  
   102  ## License
   103  
   104  This code is distributed under the MIT license, see the [LICENSE][] file.
   105  
   106  [Changelog]: https://github.com/AlloyCI/alloy-runner/blob/master/CHANGELOG.md
   107  [golang]: https://golang.org/
   108  [LICENSE]: https://github.com/AlloyCI/alloy-runner/tree/master/LICENSE
   109  [TOML]: https://github.com/toml-lang/toml