aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/deployment.rst59
-rw-r--r--documentation/migrations.rst4
2 files changed, 22 insertions, 41 deletions
diff --git a/documentation/deployment.rst b/documentation/deployment.rst
index 8a7f098d..59080b89 100644
--- a/documentation/deployment.rst
+++ b/documentation/deployment.rst
@@ -3,7 +3,8 @@ Deployment
This application can be deployed on Heroku or on a traditional server.
-After installation, you will be able to connect with the email *root@pyAggr3g470r.localhost* and the password *password*.
+After installation, you will be able to connect with the email
+*root@pyAggr3g470r.localhost* and the password *password*.
Deploying the application with Vagrant
--------------------------------------
@@ -13,8 +14,8 @@ Installation of VirtualBox and Vagrant
.. code-block:: bash
$ sudo apt-get install virtualbox
- $ wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.6.5_x86_64.deb
- $ sudo dpkg -i vagrant_1.6.5_x86_64.deb
+ $ wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.7.2_x86_64.deb
+ $ sudo dpkg -i vagrant_1.7.2_x86_64.deb
Deployment of pyAggr3g470r
@@ -45,7 +46,8 @@ The geek way
$ heroku run init
$ heroku ps:scale web=1
-To enable account creation for users, you have to set some environment variables:
+To enable account creation for users, you have to set some environment
+variables:
.. code-block:: bash
@@ -79,50 +81,27 @@ Deploying the application on a traditional server
.. code-block:: bash
- $ sudo apt-get install python libpq-dev python-dev python-pip build-essential git
- $ sudo apt-get install libxml2-dev libxslt1-dev # for lxml
$ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
- $ cd pyaggr3g470r
- $ sudo pip install --upgrade -r requirements.txt
- $ cp conf/conf.cfg-sample conf/conf.cfg
+ $ cd pyaggr3g470r/
If you want to use PostgreSQL
'''''''''''''''''''''''''''''
-
.. code-block:: bash
- $ sudo apt-get install postgresql postgresql-server-dev-9.3 postgresql-client
- $ pip install psycopg2
- $ echo "127.0.0.1:5432:aggregator:pgsqluser:pgsqlpwd" > ~/.pgpass
- $ chmod 700 ~/.pgpass
- $ sudo -u postgres createuser pgsqluser --no-superuser --createdb --no-createrole
- $ createdb aggregator --no-password
- $ echo "ALTER USER pgsqluser WITH ENCRYPTED PASSWORD 'pgsqlpwd';" | sudo -u postgres psql
- $ echo "GRANT ALL PRIVILEGES ON DATABASE aggregator TO pgsqluser;" | sudo -u postgres psql
-
-Edit the configuration file with the line:
-
-.. code-block:: cfg
-
- [database]
- uri = postgres://pgsqluser:pgsqlpwd@127.0.0.1:5433/aggregator
+ $ ./install.sh postgres
If you want to use SQLite
'''''''''''''''''''''''''
-Just edit the configuration file with the line:
-
-.. code-block:: cfg
+.. code-block:: bash
- [database]
- uri = sqlite+pysqlite:///pyAggr3g470r.db
+ $ ./install.sh sqlite
Finally:
.. code-block:: bash
- $ python manager.py db_create
$ python runserver.py
* Running on http://0.0.0.0:5000/
* Restarting with reloader
@@ -131,20 +110,22 @@ Finally:
Configuration
=============
-Configuration (database url, email, proxy, user agent, etc.) is done via the file *conf/conf.cfg*.
-Check these configuration before executing *db_create.py*.
-If you want to use pyAggr3g470r with Tor/Privoxy, you just have to set the value of
-*http_proxy* (most of the time: *http_proxy = 127.0.0.1:8118**). Else leave the value blank.
+Configuration (database url, email, proxy, user agent, etc.) is done via the
+file `conf/conf.cfg`.
+Check this file before initializing the database (with `manager.py`).
+
+If you want to use pyAggr3g470r with Tor/Privoxy, you just have to set the value
+of `http_proxy` (most of the time: `http_proxy = 127.0.0.1:8118`). Else leave
+the value blank.
Automatic updates
=================
-You can fetch new articles with `cron <https://en.wikipedia.org/wiki/Cron>`_ and the script *fetch.py*.
-For example if you want to check for updates every 30 minutes, add this line to your cron rules (*crontab -e*):
+You can fetch new articles with `cron <https://en.wikipedia.org/wiki/Cron>`_.
+For example if you want to check for updates every 30 minutes, add this line to
+your cron rules (*crontab -e*):
.. code-block:: bash
*/30 * * * * cd ~/.pyaggr3g470r/ ; python manager.py fetch_asyncio None None
-
-You must give the email address you use to login to pyAggr3g470r.
diff --git a/documentation/migrations.rst b/documentation/migrations.rst
index 69f6c974..97d2c0f9 100644
--- a/documentation/migrations.rst
+++ b/documentation/migrations.rst
@@ -14,11 +14,11 @@ Local migrations
.. code-block:: bash
- $ python manage.py db upgrade
+ $ python manager.py db upgrade
Remote migrations
-----------------
.. code-block:: bash
- $ heroku run python manage.py db upgrade
+ $ heroku run python manager.py db upgrade
bgstack15