aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/installation.md
diff options
context:
space:
mode:
authorAdam Janovsky2022-04-26 16:10:36 +0200
committerAdam Janovsky2022-04-26 16:10:36 +0200
commite6a433e86be235cb4bfc0b80bcef719df42812d7 (patch)
tree680d7bda871fb2b898dc9093ebaef3d0fbf49fa9 /docs/installation.md
parent8e7a3d8a172f62e13833f4d033b52e0cd38d66f6 (diff)
downloadsec-certs-e6a433e86be235cb4bfc0b80bcef719df42812d7.tar.gz
sec-certs-e6a433e86be235cb4bfc0b80bcef719df42812d7.tar.zst
sec-certs-e6a433e86be235cb4bfc0b80bcef719df42812d7.zip
add simple installation instr. and quickstart
Diffstat (limited to 'docs/installation.md')
-rw-r--r--docs/installation.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/docs/installation.md b/docs/installation.md
index 0e6c025a..236a9dc9 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -1,3 +1,32 @@
# Installation
-TBA \ No newline at end of file
+The tool can be pulled as a docker image with
+
+```bash
+docker pull seccerts/sec-certs
+```
+
+Alternatively, it can be installed from PyPi with
+
+```bash
+pip install -U sec-certs
+```
+
+Note, however, that `Python>=3.8` is required and there are some additional dependencies (see below) that are not shipped with the binary distribution.
+
+The stable release is also published on [GitHub](https://github.com/crocs-muni/sec-certs/releases) from where it can be setup for development with
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e .
+```
+
+Alternatively, our Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/docker/Dockerfile) represents a reproducible way of setting up the environment.
+
+## Dependencies
+
+- [Java](https://www.java.com/en) is needed to parse tables in FIPS pdf documents, must be available from `PATH`.
+- Some imported libraries have non-trivial dependencies to resolve:
+ - [pdftotext](https://github.com/jalan/pdftotext) requires [Poppler](https://poppler.freedesktop.org/) to be installed. We've experienced issues with older versions of Poppler (`0.x`), make sure to install `20.x` version of these libraries.
+ - [graphviz](https://pypi.org/project/graphviz/) requires `graphviz` to be on the path \ No newline at end of file