Skip to content

Commit

Permalink
Installation readme added
Browse files Browse the repository at this point in the history
  • Loading branch information
bjarnoldus committed May 31, 2016
1 parent 5406122 commit e73e740
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 6 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,45 @@ Main Features

Installation
--------------
BounCA is Django / Python3 based, and it is recommended to deploy BounCA to its own linux environment, like a virtual machine.. Note that it is best practice to create the root pair in a secure environment. Ideally, this should be on a fully encrypted, air gapped computer that is permanently isolated from the Internet.

More info about the installation: [BounCA Installation Tutorials](https://www.bounca.org/getting-started.html)
BounCA is a Django application running on a Python3 environment.
While it is highly portable setup, we suggest you deploy a (virtual) machine with the following configuration:

* Debian Jessie Linux
* Key authentication for the Root user

Ansible offers the easiest way of creating a BounCA deployment for hosting your Certificate Authority.

You need to have (root) access to a fresh installed Debian Jessie (virtual) machine. On your local machine you need to have a recent 2+ Ansible installation.
Create your playbook ``install-bounca.yml``:

- hosts: all
remote_user: root
roles:
- { role: repleo.bounca,
bounca_timezone: /usr/share/zoneinfo/Europe/Amsterdam,
bounca_db_user: bounca,
bounca_db_password: <YOUR DB PASSWORD>,
bounca_db_host: localhost,
bounca_db_name: bouncadb,

bounca_secret_key: <DJANGO SECRET>,
bounca_email_host: localhost,
bounca_admin_mail: bounca-admin@<YOURDOMAIN>,
bounca_from_mail: no-reply@<YOURDOMAIN>
}

Ansible will install the database, webserver and so on. The parameters you provide in the playbook are used to instantiate the services.
After you created the playbook, you can install BounCA by executing the following commands:

ansible-galaxy install repleo.bounca -p ./roles
ansible-playbook install-bounca.yml -i <HOSTNAME_OR_IP>,

The first collects the ansible roles from Ansible's galaxy.
The second command installs the actual BounCA system.

More installation options, such as docker and manual: [BounCA Installation Tutorials](https://www.bounca.org/getting-started.html)

Requirements
------------------
Expand Down
2 changes: 1 addition & 1 deletion bounca/static/docs/_sources/getting_started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Ansible Deployment

`Ansible`_ offers the easiest way of creating a BounCA deployment for hosting your Certificate Authority.

You need to have (root) access to a fresh installed Debian Jessie (virtual) machine. On your local machine you need to have a recent 2+ Ansbile installation.
You need to have (root) access to a fresh installed Debian Jessie (virtual) machine. On your local machine you need to have a recent 2+ Ansible installation.
Create your playbook ``install-bounca.yml``:

.. code-block:: yaml
Expand Down
2 changes: 1 addition & 1 deletion bounca/static/docs/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h2>Prepare your Environment<a class="headerlink" href="#prepare-your-environmen
<div class="section" id="ansible-deployment">
<span id="deploy-ansible"></span><h3>Ansible Deployment<a class="headerlink" href="#ansible-deployment" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="http://www.ansible.com/">Ansible</a> offers the easiest way of creating a BounCA deployment for hosting your Certificate Authority.</p>
<p>You need to have (root) access to a fresh installed Debian Jessie (virtual) machine. On your local machine you need to have a recent 2+ Ansbile installation.
<p>You need to have (root) access to a fresh installed Debian Jessie (virtual) machine. On your local machine you need to have a recent 2+ Ansible installation.
Create your playbook <code class="docutils literal"><span class="pre">install-bounca.yml</span></code>:</p>
<div class="highlight-yaml"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">hosts</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">all</span>
<span class="l l-Scalar l-Scalar-Plain">remote_user</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">root</span>
Expand Down
Loading

0 comments on commit e73e740

Please sign in to comment.