Skip to content

Commit

Permalink
#8: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blackandred committed Nov 17, 2020
1 parent 7a1605b commit 2973849
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions docs/source/first-steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,23 @@ Infracheck can work as a HTTP endpoint responding with JSON, or as a console com

You need to install all requirements manually if you decide not to use a docker container.

Requirements:
**Requirements:**

- Python 3.6+
- Python 3.7+
- OpenSSH Client
- sshpass
- mysql-client
- postgresql-client
- docker client
- sshpass (for SSH checks)
- whois (for domain checks)
- mysql-client (for MySQL checks)
- postgresql-client (for PostgreSQL checks)
- docker client (for Docker checks)
- curl


**Python package requirements:**

.. literalinclude:: ../../requirements.txt


2. Structure
------------

Expand Down Expand Up @@ -80,12 +86,19 @@ Hint: You can pass environment variables in parameters - see: :ref:`Templating`

**With Docker**

You can use a ready-to-use docker image **wolnosciowiec/infracheck** or **wolnosciowiec/infracheck:armhf** for 32 bit ARM.
You can use a ready-to-use docker image **quay.io/riotkit/infracheck** or **quay.io/riotkit/infracheck** for ARM.
Please check `the list of available versions <https://quay.io/repository/riotkit/infracheck?tab=tags>`_.

The image will by default expose a HTTP endpoint.

.. _the list of available versions: https://quay.io/repository/riotkit/infracheck?tab=tags

.. code:: bash
sudo docker run --name infracheck -p 8000:8000 -v $(pwd):/data -d --rm wolnosciowiec/infracheck
# create directory structure that will be present in "/data" inside container (see one of previous steps about the structure)
mkdir checks configured
sudo docker run --name infracheck -p 8000:8000 -v $(pwd):/data -d --rm quay.io/riotkit/infracheck:v1.9-x86_64
# now test it
curl http://localhost:8000
Expand All @@ -102,7 +115,7 @@ List of supported environment variables:
git clone https://github.com/riotkit-org/infracheck
cd infracheck
make install
rkd :install
# run checks in the shell
infracheck --directory=/your-project-directory-path-there
Expand Down

0 comments on commit 2973849

Please sign in to comment.