aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Glass <tribaal@gmail.com>2014-02-13 09:34:21 +0100
committerChris Glass <tribaal@gmail.com>2014-02-13 09:34:21 +0100
commit87c4edbda9c838b721546dd9f6b9964b915127b5 (patch)
tree4ebd1923ef96d1dfa64f90e52aa7886c2e3d0fe4
parent2b764a1c7b42a300a6e8b1446a25fdf13aa0eabd (diff)
downloadcryptography-87c4edbda9c838b721546dd9f6b9964b915127b5.tar.gz
cryptography-87c4edbda9c838b721546dd9f6b9964b915127b5.tar.bz2
cryptography-87c4edbda9c838b721546dd9f6b9964b915127b5.zip
Added a docs section on Linux installation
This simply adds a short paragraph on what dependencies are needed on Linux, as well as the command line to install them on Ubuntu (since users of other distributions are more likely to know how to do it).
-rw-r--r--docs/installation.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index 7e7348e2..a2fc5b7c 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -22,8 +22,26 @@ to include the corresponding locations. For example:
C:\> set INCLUDE=C:\OpenSSL-1.0.1f-64bit\include;%INCLUDE%
C:\> pip install cryptography
+Building cryptography on Linux
+------------------------------
+
+``cryptography`` should build very easily on linux provided you have headers
+for the OpenSSL and libffi available on your system.
+
+For Ubuntu, the following command line will ensure this is the case:
+
+.. code-block:: console
+
+ sudo apt-get install libssl-dev libffi-dev
+
+You should now be able to build and install cryptography with the usual
+
+.. code-block:: console
+
+ python setup.py install
+
Using your own OpenSSL on Linux
--------------------------------
+...............................
Python links to OpenSSL for its own purposes and this can sometimes cause
problems when you wish to use a different version of OpenSSL with cryptography.