Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Commit

Permalink
docs: updates to installation
Browse files Browse the repository at this point in the history
* update dependencies
* add debianish install instructions
* default to pypy

issue #565, #558
  • Loading branch information
pjenvey committed Aug 2, 2016
1 parent 2fc8b45 commit aa6729b
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,48 @@ System Requirements
Autopush requires the following to be installed. Since each system has different
methods and package names, it's best to search for each package.

* python 2.7.7 (or later) with the following flags set:
* --enable-unicode=usc4 --enable-ipv6
* build-essentials (a meta package that includes:
* Python 2.7.7 (or later 2.7.x), either
* PyPy 5.0.1 or later **or**
* CPython compiled with the following flags:
* --enable-unicode=usc4 --enable-ipv6
* build-essential (a meta package that includes):
* autoconf
* automake
* gcc
* make
* pypy **or** python (CPython) development (header files)
* libffi development
* libncurses5 development
* openssl development
* patch
* python development
* python virtualenv
* readline development
* git

For instance, if installing on an Amazon EC2 machine:
For instance, if installing on a Fedora or RHEL-like Linux (e.g. an Amazon EC2
instance):

.. code-block:: bash
$ sudo yum install autoconf automake gcc make libffi-devel \
libncurses5-devel openssl-devel patch python-devel \
python-virtualenv readline-devel -y
openssl-devel pypy pypy-devel python-virtualenv git -y
Or a Debian based system (like Ubuntu):

.. code-block:: bash
$ sudo apt-get install build-essential libffi-dev \
libssl-dev pypy-dev python-virtualenv git --assume-yes
Autopush uses the `Boto python library <https://boto.readthedocs.io/en/latest/>`_. Be sure to `properly set up <https://boto.readthedocs.io/en/latest/boto_config_tut.html>`_ your boto configuration file.

Python 2.7.7+ w/virtualenv
==========================

You will need ``virtualenv`` installed per the above requirements. Set up your virtual environment by running
You will need ``virtualenv`` installed per the above requirements. Set up
your virtual environment by running the following (if using
PyPy, you'll likely need to specify the ``-p <path to pypy>`` option):

.. code-block:: bash
$ virtualenv .
$ virtualenv -p `which pypy` .
Then run the Makefile with ``make`` to setup the application.

Expand All @@ -63,7 +72,7 @@ environment variable, and add your OpenSSL library path to ``LDFLAGS`` and
export LDFLAGS="-L/usr/local/lib" CFLAGS="-I/usr/local/include"
Notes on GCM/FCM support
====================
========================
autopush is capable of routing messages over Google Cloud Messaging/Firebase Cloud Messaging for android
devices. You will need to set up a valid `GCM <http://developer.android.com/google/gcm/index.html>`_ / `FCM <https://firebase.google.com/docs/cloud-messaging/>`_ account. Once you have an account open the Google Developer Console:

Expand Down

0 comments on commit aa6729b

Please sign in to comment.