Skip to content

document better different dependencies #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anarcat wants to merge 1 commit into
base: master
Choose a base branch
from
Open

document better different dependencies #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/global.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
.. _HMAC-SHA256: http://en.wikipedia.org/wiki/HMAC
.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
.. _ACL: https://en.wikipedia.org/wiki/Access_control_list
.. _libacl: http://savannah.nongnu.org/projects/acl/
.. _github: https://github.com/jborg/attic
.. _OpenSSL: https://www.openssl.org/
.. _Python: http://www.python.org/
Expand Down
24 changes: 20 additions & 4 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,34 @@ Other dependencies:

* `msgpack-python`_ >= 0.1.10
* OpenSSL_ >= 1.0.0
* libacl_

The OpenSSL version bundled with Mac OS X and FreeBSD is most likey too old.
Newer versions are available from homebrew_ on OS X and from FreeBSD ports.

The llfuse_ python package is also required if you wish to mount an
archive as a FUSE filesystem.

Common compilation pre-requisites
---------------------------------

The following Debian packages are generally necessary to compile
|project_name|, either through pip, the tarball or git::

$ sudo apt-get install python3 python3-dev python3-msgpack python3-sphinx libssl-dev libacl1-dev
Copy link

@k0st1an k0st1an Jul 1, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!


Installing from PyPI using pip
------------------------------
::

$ pip install Attic
To install |project_name| system-wide::

$ sudo pip3 install Attic

To install it in a user-specific account::

$ pip3 install --user Attic

Then add ``$HOME/.library/bin`` to your ``$PATH``.

Installing from source tarballs
-------------------------------
Expand All @@ -32,15 +48,15 @@ Installing from source tarballs
$ curl -O :targz_url:`Attic`
$ tar -xvzf |package_filename|
$ cd |package_dirname|
$ python setup.py install
$ sudo python3 setup.py install

Installing from git
-------------------
.. parsed-literal::

$ git clone |git_url|
$ cd attic
$ python setup.py install
$ sudo python3 setup.py install

Please note that when installing from git, Cython_ is required to generate some files that
are normally bundled with the release tarball.
Expand Down