[#trackit-logo] image::https://s3-us-west-2.amazonaws.com/trackit-public-artifacts/github-page/logo.png[]

TrackIt helps you to optimize your AWS cloud

= Trackit

This is a tool written in go to optimize your AWS usage and spending.

This repository contains the deployment tools to run TrackIt easily on your own infrastructure.

image::https://s3-us-west-2.amazonaws.com/trackit-public-artifacts/github-page/v2_cost_breakdown.png[]

== Don't want to self-host trackit?

We run our own version, check it out at https://trackit.io/[TrackIt]

== Repository structure

• Deployment tools: https://github.com/trackit/trackit
• Go server: https://github.com/trackit/trackit-server
• ReactJS UI: https://github.com/trackit/trackit-client

You can still find our legacy version at https://github.com/trackit/trackit-legacy.

= Installation

=== #0 Be sure all requirements below are met

• Install https://docs.docker.com/engine/installation/[Docker]
• Install https://docs.docker.com/compose/install/[Docker Compose]
• Install https://docs.aws.amazon.com/cli/latest/userguide/installing.html[AWS CLI] and https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[configure your credentials]
• Make sure the port 80 and 8080 are open
• Docker-for-Mac and Docker-for-Windows users: Increase the docker memory limit to 4GB to allow elasticsearch to run properly

Here is the access your AWS IAM credentials will need to run correctly TrackIt [source,json]

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AssumeRole", "Effect": "Allow", "Action": "sts:AssumeRole", "Resource": "*" } ] }

=== #1 Clone this repository

[source,sh]

$> git clone https://github.com/trackit/trackit && cd trackit

=== #2 Configure the API_URL If you are not running TrackIt on your local machine, you need to configure the URL of the API: [source,sh]

$> vi docker-compose.yml line 8: - API_URL=http://localhost:8080 # replace localhost by the public API of the host

=== #3 Start TrackIt [source,sh]

$> ./start.sh

== Configuring

More information about configuring TrackIt? Check our step-by-step guide https://trackit.io/installing-setting-trackit-up-step-by-step/[here]