github.com/chenbh/concourse/v6@v6.4.2/README.md (about)

     1  # Concourse: the continuous thing-doer.
     2  
     3  Concourse is an automation system written in Go. It is most commonly used for
     4  CI/CD, and is built to scale to any kind of automation pipeline, from simple to
     5  complex.
     6  
     7  ![booklit pipeline](screenshots/booklit-pipeline.png)
     8  
     9  Concourse is very opinionated about a few things: idempotency, immutability,
    10  declarative config, stateless workers, and reproducible builds.
    11  
    12  ## Installation
    13  
    14  Concourse is distributed as a single `concourse` binary, available on the [Releases page](https://github.com/concourse/concourse/releases/latest).
    15  
    16  If you want to just kick the tires, jump ahead to the [Quick Start](#quick-start).
    17  
    18  In addition to the `concourse` binary, there are a few other supported formats.
    19  Consult their GitHub repos for more information:
    20  
    21  * [Docker image](https://github.com/concourse/concourse-docker)
    22  * [BOSH release](https://github.com/concourse/concourse-bosh-release)
    23  * [Kubernetes Helm chart](https://github.com/concourse/concourse-chart)
    24  
    25  
    26  ## Quick Start
    27  
    28  ```sh
    29  $ wget https://concourse-ci.org/docker-compose.yml
    30  $ docker-compose up
    31  Creating docs_concourse-db_1 ... done
    32  Creating docs_concourse_1    ... done
    33  ```
    34  
    35  Concourse will be running at [127.0.0.1:8080](http://127.0.0.1:8080). You can
    36  log in with the username/password as `test`/`test`.
    37  
    38  Next, install `fly` by downloading it from the web UI and target your local
    39  Concourse as the `test` user:
    40  
    41  ```sh
    42  $ fly -t ci login -c http://127.0.0.1:8080 -u test -p test
    43  logging in to team 'main'
    44  
    45  target saved
    46  ```
    47  
    48  ### Configuring a Pipeline
    49  
    50  There is no GUI for configuring Concourse. Instead, pipelines are configured as
    51  declarative YAML files:
    52  
    53  ```yaml
    54  resources:
    55  - name: booklit
    56    type: git
    57    source: {uri: "https://github.com/vito/booklit"}
    58  
    59  jobs:
    60  - name: unit
    61    plan:
    62    - get: booklit
    63      trigger: true
    64    - task: test
    65      file: booklit/ci/test.yml
    66  ```
    67  
    68  Most operations are done via the accompanying `fly` CLI. If you've got Concourse
    69  [installed](https://concourse-ci.org/install.html), try saving the above example
    70  as `booklit.yml`, [target your Concourse
    71  instance](https://concourse-ci.org/fly.html#fly-login), and then run:
    72  
    73  ```sh
    74  fly -t ci set-pipeline -p booklit -c booklit.yml
    75  ```
    76  
    77  These pipeline files are self-contained, maximizing portability from one
    78  Concourse instance to the next.
    79  
    80  
    81  ### Learn More
    82  
    83  * The [Official Site](https://concourse-ci.org) for documentation,
    84    reference material, and example pipelines (which no longer live in this repository).
    85  * The [Concourse Tutorial](https://concoursetutorial.com) by Stark & Wayne is
    86    great for a guided introduction to all the core concepts.
    87  * See Concourse in action with our [production pipelines](https://ci.concourse-ci.org/)
    88  * Hang around in the [forums](https://discuss.concourse-ci.org) or in
    89    [Discord](https://discord.gg/MeRxXKW).
    90  * See what we're working on on the [project board](https://github.com/orgs/concourse/projects). 
    91  
    92  
    93  ## Contributing
    94  
    95  Our user base is basically everyone that develops software (and wants it to
    96  work).
    97  
    98  It's a lot of work, and we need your help! If you're interested, check out our
    99  [contributing docs](CONTRIBUTING.md).
   100