<commit_before>What is Alerta?
===============

The alerta monitoring system is a tool used to consolidate and
de-duplicate alerts from multiple sources for quick ‘at-a-glance’
visualisation. With just one system you can monitor alerts from
many other monitoring tools on a single screen.

How to use this image
=====================

To use this image run a `mongo` container first:

    $ docker run --name alerta-db -d mongo

Then link to the `mongo` container when running the `alerta-web` container:

    $ docker run --name alerta-web --link alerta-db:mongo -d -p <port>:80 alerta/alerta-web

The API endpoint is at:

    http://<docker>:<port>/api

Browse to the alerta console at:

    http://<docker>:<port>/

Environment Variables
---------------------

The following environment variables are supported for configuring
the `alerta-web` container:

`DEBUG`
    - debug mode. Set to ``True`` for increased logging.

`BASE_URL`
    - used to fix relative links. (default: `/api`)

`SECRET_KEY`
    - a unique, randomly generated sequence of ASCII characters.

`MONGO_URI`
    - MongoDB connection URI string.

`AUTH_REQUIRED`
    - require users to authenticate when using web UI or `alerta` CLI.
<commit_msg>Fix example docker run command that uses links<commit_after>What is Alerta?
===============

The alerta monitoring system is a tool used to consolidate and
de-duplicate alerts from multiple sources for quick ‘at-a-glance’
visualisation. With just one system you can monitor alerts from
many other monitoring tools on a single screen.

How to use this image
=====================

To use this image run a `mongo` container first:

    $ docker run --name alerta-db -d mongo

Then link to the `mongo` container when running the `alerta-web` container:

    $ export MONGO_URI=mongodb://db:27017/monitoring
    $ docker run --name alerta-web -e MONGO_URI=$MONGO_URI --link alerta-db:db \
    -d -p <port>:80 alerta/alerta-web

The API endpoint is at:

    http://<docker>:<port>/api

Browse to the alerta console at:

    http://<docker>:<port>/

Environment Variables
---------------------

The following environment variables are supported for configuring
the `alerta-web` container:

`DEBUG`
    - debug mode. Set to ``True`` for increased logging.

`BASE_URL`
    - used to fix relative links. (default: `/api`)

`SECRET_KEY`
    - a unique, randomly generated sequence of ASCII characters.

`MONGO_URI`
    - MongoDB connection URI string.

`AUTH_REQUIRED`
    - require users to authenticate when using web UI or `alerta` CLI.

{'fraction_non_alphanumeric': 0.12603062426383982, 'fraction_numerical': 0.0035335689045936395, 'mean_word_length': 3.4467713787085517, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2783927', 'n_tokens_mistral': 784, 'n_tokens_neox': 733, 'n_words': 311}