Skip to content

Commit

Permalink
Fix left over markdown tags to Rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke Hinds committed Apr 12, 2019
1 parent f9e45ca commit 8b682cb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 24 deletions.
6 changes: 3 additions & 3 deletions docs/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ When contributing to this repository, please first discuss the change you wish
to make via an issue in the relevant repository for your change or email to the
[keylime mailing list](https://groups.io/g/keylime).

## Pull Request Process
Pull Request Process
~~~~~~~~~~~~~~~~~~~~

1. Create an [issue](https://github.com/keylime/python-keylime/issues)
outlining the fix or feature.
Expand Down Expand Up @@ -39,7 +40,7 @@ how to set that up.

As an example, on Fedora 29:

.. code-block:: bash

sudo dnf -y install dnf-plugins-core
sudo dnf install docker-ce docker-ce-cli containerd.io
sudo usermod -aG docker $USER
Expand All @@ -52,7 +53,6 @@ Note: login and out of your shell, if you want to run docker as `$USER`
Save the following script to your local machine (tip: create an alias to call the
script in an easy to remember way)

.. code-block:: bash
#!/bin/bash

# Your local python-keylime (you should likely change this)
Expand Down
29 changes: 8 additions & 21 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Usage

Run the example playbook against your target remote node(s).

.. code-block:: bash
ansible-playbook -i your_hosts playbook.yml


Expand All @@ -37,43 +36,38 @@ the role in the `playbook.yml` file `here <https://github.com/keylime/ansible-ke

For TPM 2.0 use:

.. code-block:: bash
- ansible-keylime-tpm20


For TPM 1.20 use:

.. code-block:: bash
- ansible-keylime-tpm12


Both roles will deploy the relevant TPM 1.2 Emulator (tpm4720) or 2.0 Emulator
(IBM software TPM).

Vagrant
-------
~~~~~~~

If you prefer, a Vagrantfile is available for provisioning.

Clone the repository and then simply run `vagrant up --provider <provider> --provision`

For example, using libvirt:

.. code-block:: bash
vagrant up --provider libvirt --provision


For example, using VirtualBox:

.. code-block:: bash
vagrant up --provider virtualbox --provision

Once the VM is started, vagrant ssh into the VM and run `sudo su` - to
become root.

You can then start the various components using commands:

.. code-block:: bash
keylime_verifier
keylime_registrar
keylime_node
Expand All @@ -95,7 +89,6 @@ Rust Cloud node
To start the rust cloud node, navigate to it's repository directory and use
cargo to run:

.. code-block:: bash
[root@localhost rust-keylime]# RUST_LOG=keylime_node=trace cargo run
Finished dev [unoptimized + debuginfo] target(s) in 0.28s
Running `target/debug/keylime_node`
Expand All @@ -111,7 +104,6 @@ Keylime requires Python 2.7.10 or newer for proper TLS support.
Installation can be performed via an automated shell script, `installer.sh`. The
following command line options are available:

.. code-block:: bash
Usage: ./installer.sh [option...]
Options:
-k Download Keylime (stub installer mode)
Expand Down Expand Up @@ -172,7 +164,6 @@ See README.md in that project for detailed instructions on how to build and inst

The brief synopsis of a quick build/install (after installing dependencies) is:

.. code-block:: bash
git clone https://github.com/keylime/tpm4720-keylime.git
cd tpm4720-keylime/libtpm
./comp-chardev.sh
Expand All @@ -194,7 +185,6 @@ README.md in these projects for detailed instructions on how to build and instal

The brief synopsis of a quick build/install (after installing dependencies) is:

.. code-block:: bash
git clone https://github.com/tpm2-software/tpm2-tss.git tpm2-tss
pushd tpm2-tss
./bootstrap
Expand Down Expand Up @@ -224,7 +214,6 @@ detailed instructions on how to build and install.

A brief, workable example for Ubuntu 18 LTS systems is:

.. code-block:: bash
sudo useradd --system --user-group tss
git clone https://github.com/tpm2-software/tpm2-abrmd.git tpm2-abrmd
pushd tpm2-abrmd
Expand All @@ -242,8 +231,7 @@ A brief, workable example for Ubuntu 18 LTS systems is:
export TPM2TOOLS_TCTI="tabrmd:bus_name=com.intel.tss2.Tabrmd"

# NOTE: if using swtpm2 emulator, you need to run the tpm2-abrmd service as:
sudo -u tss /usr/local/sbin/tpm2-abrmd --tcti=mssim &
```
sudo -u tss /usr/local/sbin/tpm2-abrmd --tcti=mssim &

Alternatively, it is also possible, though not recommended, to communicate
directly with the TPM (and not use a resource manager). This can be done by
Expand All @@ -258,20 +246,19 @@ Install Keylime

You're finally ready to install keylime!

.. code-block:: bash
sudo python setup.py install

To run on OSX 10.11+
~~~~~~~~~~~~~~~~~~~~

You need to build m2crypto from source with

```bash
brew install openssl
git clone https://gitlab.com/m2crypto/m2crypto.git
python setup.py build build_ext --openssl=/usr/local/opt/openssl/
sudo -E python setup.py install build_ext --openssl=/usr/local/opt/openssl/
```

brew install openssl
git clone https://gitlab.com/m2crypto/m2crypto.git
python setup.py build build_ext --openssl=/usr/local/opt/openssl/
sudo -E python setup.py install build_ext --openssl=/usr/local/opt/openssl/


Optional Requirements
~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 8b682cb

Please sign in to comment.