Skip to content
Snippets Groups Projects
Commit 0c558be7 authored by Damian Johnson's avatar Damian Johnson
Browse files

File and signature documentation 

I bundled our tarball and signature under PyPI as an afterthought. Expanding
this into its own listing with FAQ instructions for how to validate.
parents 4164c7a6 562d571c
Branches
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 109 additions and 32 deletions
docs/_static/label/file.png 0 → 100644
+ 0
− 0
View file @ 0c558be7
docs/_static/label/file.png

678 B

docs/_static/label/mac_os.png 0 → 100644
+ 0
− 0
View file @ 0c558be7
docs/_static/label/mac_os.png

1.46 KiB

docs/_static/label/osx.png deleted 100644 → 0
+ 0
− 0
View file @ 4164c7a6
docs/_static/label/osx.png

1.73 KiB

docs/_static/label/resources/file.xcf 0 → 100644
+ 0
− 0
View file @ 0c558be7
File added
docs/_static/label/resources/mac_os.xcf 0 → 100644
+ 0
− 0
View file @ 0c558be7
File added
docs/_static/label/resources/osx.xcf deleted 100644 → 0
+ 0
− 0
View file @ 4164c7a6
File deleted
docs/_static/section/download/file.png 0 → 100644
+ 0
− 0
View file @ 0c558be7
docs/_static/section/download/file.png

8.08 KiB

docs/_static/style.css
+ 3
− 0
View file @ 0c558be7
......@@ -20,3 +20,6 @@ img {
max-width: none !important;
}
.align-default {
text-align: left !important;
}
docs/_templates/layout.html
+ 1
− 1
View file @ 0c558be7
......@@ -47,7 +47,7 @@
<li><a href="{{ pathto('api') }}#utilities">Utilities</a></li>
</ul>
</li>
<li>Development
<li><a href="https://github.com/torproject/stem/">Development</a>
<ul>
<li><a href="{{ pathto('faq') }}">FAQ</a></li>
<li><a href="{{ pathto('change_log') }}">Change Log</a></li>
......
docs/download.rst
+ 63
− 31
View file @ 0c558be7
......@@ -7,7 +7,7 @@ Download
Source: http://www.python.org/community/logos/
License: http://www.python.org/psf/trademarks
* OSX
* Mac OS
Source: IconArchive (http://www.iconarchive.com/show/papercut-social-icons-by-graphicloads/Apple-icon.html)
Author: GraphicLoads, Papercut Social Icons
License: Freeware
......@@ -59,6 +59,12 @@ Download
Source: https://www.netbsd.org/gallery/logos.html
License: https://www.netbsd.org/about/redistribution.html
* File
Source: NuoveXT (http://nuovext.pwsp.net/)
Author: Alexandre Moore (http://sa-ki.deviantart.com/)
License: GPL v2
File: NuoveXT/128x128/mimetypes/gnome-mime-application-x-archive.png
* Git
Source: https://en.wikipedia.org/wiki/File:Git-logo.svg
Author: Jason Long
......@@ -76,41 +82,40 @@ Download
* - .. image:: /_static/section/download/pypi.png
:target: https://pypi.org/project/stem/
- .. image:: /_static/label/python_package_index.png
- .. _pypi:
.. image:: /_static/label/python_package_index.png
:target: https://pypi.org/project/stem/
Signed releases and instructions for both Python 2.x and 3.x. You can
easily install from its `tarball
<https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz>`_
(`sig
<https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz.asc>`_),
or with **pip**...
You can install our latest release from the Python Package Index (PyPI)
with **pip**...
::
% sudo easy_install pip
% sudo pip install stem
* - .. image:: /_static/section/download/osx.png
* - .. image:: /_static/section/download/mac.png
- .. image:: /_static/label/osx.png
- .. _osx:
.. image:: /_static/label/mac_os.png
As of OSX 10.8 the platform bundles Python 2.7 by default. This makes
Mac OS 10.8 and above bundle Python by default. This makes
installation easy...
::
% sudo easy_install pip
% sudo pip install stem
* - .. image:: /_static/section/download/debian.png
:target: https://packages.debian.org/sid/python-stem
- .. image:: /_static/label/debian.png
- .. _debian:
.. image:: /_static/label/debian.png
:target: https://packages.debian.org/sid/python-stem
Packages by Dererk for Debian, including `python-stem
<https://packages.debian.org/sid/python-stem>`_ (for Python 2.x) and
Packages maintained by `Dererk
<https://nm.debian.org/person/dererk/>`_ for Debian
include `python-stem <https://packages.debian.org/sid/python-stem>`_
(for Python 2.x) and
`python3-stem <https://packages.debian.org/sid/python3-stem>`_ (for
Python 3.x).
......@@ -121,7 +126,8 @@ Download
* - .. image:: /_static/section/download/ubuntu.png
:target: https://launchpad.net/ubuntu/+source/python-stem
- .. image:: /_static/label/ubuntu.png
- .. _ubuntu:
.. image:: /_static/label/ubuntu.png
:target: https://launchpad.net/ubuntu/+source/python-stem
Package derived from Debian for Ubuntu.
......@@ -133,11 +139,13 @@ Download
* - .. image:: /_static/section/download/fedora.png
:target: https://apps.fedoraproject.org/packages/python-stem
- .. image:: /_static/label/fedora.png
- .. _fedora:
.. image:: /_static/label/fedora.png
:target: https://apps.fedoraproject.org/packages/python-stem
Packages maintained by Juan for Fedora using **dnf** or **yum**. These
include **python-stem** (for Python 2.x), **python3-stem** (for Python
Packages maintained by `Juan
<https://fedoraproject.org/wiki/User:Jorti>`_ for Fedora include
**python-stem** (for Python 2.x), **python3-stem** (for Python
3.x), and **python-stem-doc** (this website).
::
......@@ -147,10 +155,13 @@ Download
* - .. image:: /_static/section/download/gentoo.png
:target: http://packages.gentoo.org/package/net-libs/stem
- .. image:: /_static/label/gentoo.png
- .. _gentoo:
.. image:: /_static/label/gentoo.png
:target: http://packages.gentoo.org/package/net-libs/stem
Package by Anthony Basile for Gentoo.
Package by `Anthony Basile
<https://packages.gentoo.org/maintainer/blueness@gentoo.org>`_ for
Gentoo.
::
......@@ -159,7 +170,8 @@ Download
* - .. image:: /_static/section/download/archlinux.png
:target: https://www.archlinux.org/packages/community/any/python-stem/
- .. image:: /_static/label/archlinux.png
- .. _archlinux:
.. image:: /_static/label/archlinux.png
:target: https://www.archlinux.org/packages/community/any/python-stem/
Package by Sjon for `Arch Linux <https://www.archlinux.org/>`_...
......@@ -171,11 +183,12 @@ Download
* - .. image:: /_static/section/download/slackware.png
:target: https://slackbuilds.org/repository/14.2/python/stem/
- .. image:: /_static/label/slackware.png
- .. _slackware:
.. image:: /_static/label/slackware.png
:target: https://slackbuilds.org/repository/14.2/python/stem/
Package by Markus for `Slackware
<http://slackbuilds.org/howto/>`_.
Package by `Markus <https://docs.slackware.com/wiki:user:markush>`_ for
`Slackware <http://slackbuilds.org/howto/>`_.
* - .. image:: /_static/section/download/freebsd.png
:target: http://www.freshports.org/security/py-stem/
......@@ -193,7 +206,8 @@ Download
* - .. image:: /_static/section/download/openbsd.png
:target: http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/net/py-stem/
- .. image:: /_static/label/openbsd.png
- .. _openbsd:
.. image:: /_static/label/openbsd.png
:target: http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/net/py-stem/
Port by pascal for OpenBSD.
......@@ -205,7 +219,8 @@ Download
* - .. image:: /_static/section/download/netbsd.png
:target: http://pkgsrc.se/net/py-stem
- .. image:: /_static/label/netbsd.png
- .. _netbsd:
.. image:: /_static/label/netbsd.png
:target: http://pkgsrc.se/net/py-stem
Port by Riastradh for NetBSD.
......@@ -214,14 +229,31 @@ Download
% pkg_add py37-stem
* - .. image:: /_static/section/download/file.png
:target: https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz
- .. _file:
.. image:: /_static/label/file.png
:target: https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz
`File
<https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz>`_
and `signature <https://files.pythonhosted.org/packages/7f/71/d82f4204e88be00220cc54eedb2972fd05081cb0e5ebdc537d8940b064ea/stem-1.7.1.tar.gz.asc>`_ upon which the above packages are based (`instructions <faq.html#how-do-i-validate-the-pgp-signature>`_). You
can directly install from this with...
::
% pip install stem-1.7.1.tar.gz
* - .. image:: /_static/section/download/git.png
:target: https://gitweb.torproject.org/stem.git
- .. image:: /_static/label/source_repository.png
- .. _source:
.. image:: /_static/label/source_repository.png
:target: https://gitweb.torproject.org/stem.git
For those wanting to live on the bleeding edge or contribute to Stem,
Stem's git repository can be fetched with...
For those who want to live on the bleeding edge or contribute, you can
download Stem's git repository with...
::
......
docs/faq.rst
+ 42
− 0
View file @ 0c558be7
......@@ -91,6 +91,48 @@ Stem works with **Python 3.6 and greater**.
If you require a deprecated Python version then please use Stem 1.8, which was
compatible with **Python 2.6 and above**.
.. _how_do_i_validate_the_pgp_signature:
How do I validate the PGP signature?
------------------------------------
Most `download options <download.html>`_ are maintained by their
operating system's community. Stem's author only provides `PyPI
<download.html#pypi>`_, `File <download.html#file>`_, and `Source
<download.html#source>`_.
Releases are `PGP signed <https://en.wikipedia.org/wiki/Pretty_Good_Privacy>`_
and can be validated with the `author's key
<https://www.atagar.com/pgp.html>`_...
#. `Install GPG <https://gnupg.org/>`_ if you don't already have it.
#. Download Stem's `latest release and signature <download.html#file>`_.
#. Get the `key <https://www.atagar.com/pgp.html>`_ of Stem's author...
::
% gpg --keyserver keyserver.ubuntu.com --recv-keys 0x9ABBEEC6
gpg: requesting key 9ABBEEC6 from hkp server keyserver.ubuntu.com
gpg: key 9ABBEEC6: public key "Damian Johnson (www.atagar.com) <atagar1@gmail.com>" imported
gpg: no ultimately trusted keys found
gpg: Total number processed: 1
gpg: imported: 1 (RSA: 1)
#. Validate the downloaded file with the signature...
::
% gpg --verify stem-1.7.1.tar.gz.asc stem-1.7.1.tar.gz
gpg: Signature made Wed 26 Dec 2018 03:00:43 PM PST using RSA key ID 87F30690
gpg: Good signature from "Damian Johnson (www.atagar.com) <atagar1@gmail.com>"
gpg: aka "Damian Johnson <atagar@torproject.org>"
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 6827 8CC5 DD2D 1E85 C4E4 5AD9 0445 B7AB 9ABB EEC6
Subkey fingerprint: 2AE2 24F5 C424 990A E520 6C85 8884 04C1 87F3 0690
.. _can_i_interact_with_tors_controller_interface_directly:
Can I interact with Tor's controller interface directly?
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment