From 87c4edbda9c838b721546dd9f6b9964b915127b5 Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Thu, 13 Feb 2014 09:34:21 +0100 Subject: 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). --- docs/installation.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) 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. -- cgit v1.2.3 From f82d94f3d1c15e3b71528ba98c7e5ba4b54cc8ad Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Thu, 13 Feb 2014 11:46:49 +0100 Subject: Added Debian mention, extra missing packages One tends to forget than not everyone has python-dev installed :) --- docs/installation.rst | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index a2fc5b7c..28b311cb 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,17 +22,22 @@ 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 ------------------------------- +Building cryptography on GNU/Linux +---------------------------------- + +``cryptography`` should build very easily on GNU/Linux provided you have a C +compiler and headers for Python and the OpenSSL and libffi libraries available +on your system. -``cryptography`` should build very easily on linux provided you have headers -for the OpenSSL and libffi available on your system. +Debian and Ubuntu systems +......................... -For Ubuntu, the following command line will ensure this is the case: +For Debian and Ubuntu, the following command line will ensure the required +dependencies are installed: .. code-block:: console - sudo apt-get install libssl-dev libffi-dev + sudo apt-get install build-essential libssl-dev libffi-dev python-dev You should now be able to build and install cryptography with the usual @@ -40,8 +45,8 @@ You should now be able to build and install cryptography with the usual python setup.py install -Using your own OpenSSL on Linux -............................... +Using your own OpenSSL on GNU/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. -- cgit v1.2.3 From 03829e595123879d26c4681eb180f056d549bc7f Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Thu, 13 Feb 2014 13:07:55 +0100 Subject: Added Pypy note and fixed libffi's "spelling" --- docs/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 28b311cb..f2b40892 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -26,8 +26,8 @@ Building cryptography on GNU/Linux ---------------------------------- ``cryptography`` should build very easily on GNU/Linux provided you have a C -compiler and headers for Python and the OpenSSL and libffi libraries available -on your system. +compiler, headers for Python (if you're not using Pypy), and headers for the +OpenSSL and `libffi` libraries available on your system. Debian and Ubuntu systems ......................... -- cgit v1.2.3 From ae20caaed83d86fa40be4b979f7f7553eb6277fa Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Thu, 13 Feb 2014 13:47:28 +0100 Subject: Pypy is not a real word either apparently. --- docs/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index f2b40892..9d8916e3 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -26,7 +26,7 @@ Building cryptography on GNU/Linux ---------------------------------- ``cryptography`` should build very easily on GNU/Linux provided you have a C -compiler, headers for Python (if you're not using Pypy), and headers for the +compiler, headers for Python (if you're not using `pypy`), and headers for the OpenSSL and `libffi` libraries available on your system. Debian and Ubuntu systems -- cgit v1.2.3 From 2e15c7fce6ce478039d150b4d5442b51582e77b4 Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Thu, 13 Feb 2014 19:10:10 +0100 Subject: Changed .... lines to ~~~~ and s/Gnu\/Linux/Linux/ --- docs/installation.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 9d8916e3..595ccc83 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,15 +22,15 @@ 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 GNU/Linux ----------------------------------- +Building cryptography on Linux +------------------------------ -``cryptography`` should build very easily on GNU/Linux provided you have a C +``cryptography`` should build very easily on Linux provided you have a C compiler, headers for Python (if you're not using `pypy`), and headers for the OpenSSL and `libffi` libraries available on your system. Debian and Ubuntu systems -......................... +~~~~~~~~~~~~~~~~~~~~~~~~~ For Debian and Ubuntu, the following command line will ensure the required dependencies are installed: @@ -45,8 +45,8 @@ You should now be able to build and install cryptography with the usual python setup.py install -Using your own OpenSSL on GNU/Linux -................................... +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. -- cgit v1.2.3