# rowdy

[![Build Status](https://travis-ci.org/lawliet89/rowdy.svg)](https://travis-ci.org/lawliet89/rowdy)
[![Dependency Status](https://dependencyci.com/github/lawliet89/rowdy/badge)](https://dependencyci.com/github/lawliet89/rowdy)
[![Crates.io](https://img.shields.io/crates/v/rowdy.svg)](https://crates.io/crates/rowdy)
[![Repository](https://img.shields.io/github/tag/lawliet89/rowdy.svg)](https://github.com/lawliet89/rowdy)
[![Documentation](https://docs.rs/rowdy/badge.svg)](https://docs.rs/rowdy)

Documentation: [Stable](https://docs.rs/rowdy) | [Master](https://lawliet89.github.io/rowdy/)

`rowdy` is a [Rocket](https://rocket.rs/)  based JSON Web token based authentication server
based off Docker Registry's [authentication protocol](https://docs.docker.com/registry/spec/auth/).

## Requirements

Rocket requires nightly Rust. You should probably install Rust with [rustup](https://www.rustup.rs/), then override the code directory to use nightly instead of stable. See
[installation instructions](https://rocket.rs/guide/getting-started/#installing-rust).

In particular, `rowdy` is currently targetted for `nightly-2017-10-11`.

## Testing

The crate is set up
to make use of [workspaces](http://doc.crates.io/manifest.html#the-workspace--field-optional) for
various parts of `rowdy`.

To run tests for `rowdy-diesel`, you will need to run the Docker containers for the various
databases.

```bash
docker-compose -f diesel/docker-compose.db.yml up
```

To run tests on everything, do `cargo test --all --all-features --no-fail-fast`.

## Docker Image

An musl-linked image can be built from the `Dockerfile` in the repository root. You will need at least Docker 17.05
(API version 1.29) to build.

By default, the Docker image will not start Rowdy for you. You will need to provide your own configuration file
and command line arguments. The provided `docker-compose.yml` should get you started.

You can simply define your own `docker-compose.override.yml` file. For example:

```yaml
version: "2.1"
services:
  rowdy:
    environment:
      ROCKET_ENV: production
    expose:
      - "80"
    volumes:
      - ./config:/app/config
    command: [rowdy-cli, csv, config/Config.json]
networks:
  nginx:
    external: true
```

Then, you can simply start the containers with `docker-compose up --build -d`.