https://github.com/peter-mcconnell/amald

an app designed to check urls to see if they are locked down
https://github.com/peter-mcconnell/amald

Last synced: about 16 hours ago
JSON representation

an app designed to check urls to see if they are locked down

• Host: GitHub
• URL: https://github.com/peter-mcconnell/amald
• Owner: peter-mcconnell
• License: apache-2.0
• Created: 2015-03-28T21:20:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-28T14:18:21.000Z (over 7 years ago)
• Last Synced: 2024-06-20T17:53:30.736Z (5 months ago)
• Language: Go
• Size: 3.59 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# amald

[![Build Status](https://travis-ci.org/pemcconnell/amald.svg?branch=master)](https://travis-ci.org/pemcconnell/amald)

[![Coverage Status](https://coveralls.io/repos/pemcconnell/amald/badge.svg?branch=master&service=github)](https://coveralls.io/github/pemcconnell/amald?branch=master)

[![GoDoc](https://godoc.org/github.com/pemcconnell/amald?status.svg)](https://godoc.org/github.com/pemcconnell/amald)

An app that's designed to monitor urls to see if they are under lockdown. It 

can load these urls using a combination of the following:

- text file format (urls separated by newlines)

- `gcloud` CLI

## Requirements

- download the latest stable binary for your OS from 

https://github.com/pemcconnell/amald/releases/ 

- The binary is all that's required, but if you wish to avail of the mailgun (email) notifications you'll need to include `reports/tmpl/` so that amald can find the html templates & you'll also need to ensure the `config.yaml` is set up and correctly configured.

- If you wish to utilise storage (for report summaries) you'll need to ensure that a folder `./tmp` exists and is writable (amald will create `data.json` file)

## Config

The config file will load by default at `./config.yaml`. An example config has 

been provided at `./config/example.config.yaml`. Note that if you wish to enable some of

the features you may need to configure some things first:

- `gcloud` features require the CLI to be installed & already auth'ed. It will

attempt to update `alpha` and `app` components as they are required to run

the commands that Amald uses.

- If you wish to enable Mailgun notifications an api key & api url is required.

## Run

- Run the binary (eg. `./amald`)

## Arguments

Type `./amald -h` to list the supported flags

#### Caveats

- I've only built and tested this on linux 64

- This has been built to scrape a CLI and parse the output - far from ideal & 

wide open to breaks as CLI updates wont be reflected in this tool automatically

- The lockdown only checks for 401 or if there are X-Auto-Login headers at the 

moment

- This is beta 

#### Screenies

You can run this tool however you like. Something like a cronjob would be 

useful. Here is an example of the ASCII output:

![manually ran in terminal](https://cloud.githubusercontent.com/assets/641429/9083166/ac616eec-3b60-11e5-9c48-88e59c8a0979.png)

You can enable email reports using the mailgun feature, via `config.yaml`:

![email output](https://cloud.githubusercontent.com/assets/641429/9083167/ac65af98-3b60-11e5-8f21-7e4e6f23340b.png)

PR's welcome :)

~ amald == are my apps locked down?

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/pemcconnell/amald/trend.png)](https://bitdeli.com/free "Bitdeli Badge")