INSTALL

   1 Deployment instructions for mygpo
   2 =================================
   3
   4
   5 Dependencies
   6 ------------
   7
   8 When no version number is indicated, it is advisable to install the current
   9 development version from the repository.
  10
  11   * Python (>= 2.6)
  12   * [CouchDB](https://couchdb.apache.org/) (>= 1.1)
  13   * [python-feedparser](https://github.com/kurtmckee/feedparser/)
  14   * [python-dateutil](http://niemeyer.net/python-dateutil)
  15   * [python-flup](http://trac.saddi.com/flup)
  16   * [python-imaging](http://www.pythonware.com/products/pil/)
  17   * [python-pybabel](http://babel.edgewall.org/)
  18   * [couchdbkit](https://github.com/benoitc/couchdbkit)
  19   * [Django](http://www.djangoproject.com/)
  20   * [django-couchdb-utils](http://github.com/stefankoegl/django-couchdb-utils/)
  21
  22
  23
  24 mygpo
  25 -----
  26
  27 The source for mygpo can be obtained via git
  28
  29  git clone git://github.com/gpodder/mygpo.git
  30
  31
  32
  33 CouchDB
  34 -------
  35
  36 A source distribution of CouchDB can be obtained from
  37
  38  http://couchdb.apache.org/downloads.html
  39
  40 Build and installation instructions can be found at
  41
  42  http://wiki.apache.org/couchdb/Installation
  43
  44 If you want to avoid installing a CouchDB server yourself, you can use a free
  45 CouchDB hosting service, for example from
  46
  47  http://www.iriscouch.com/service
  48
  49 Please note, however, that hosted CouchDB services generally do not provide
  50 security or authentication mechanisms, so this might only be useful for
  51 development servers.
  52
  53 If you don't use a local database, you need to update the COUCHDB_DATABASES
  54 setting (see the "Settings" section below).
  55
  56
  57
  58 1. Initializing an empty Database
  59
  60 To create the database, execute the following on the commandline
  61
  62   curl -X PUT http://127.0.0.1:5984/mygpo
  63
  64 To initialize the views, execute from the mygpo directory
  65
  66   python manage.py sync_couchdb
  67
  68
  69 2. Importing a Dump
  70
  71 To import a CouchDB dump, execute the following from the commandline
  72
  73   gunzip -c <dumpfile.couch.gz> | couchdb-load http://127.0.0.1:5984/mygpo
  74
  75
  76
  77 3. Building the Views
  78
  79 On the first request, CouchDB will build the views. To do this before the first
  80 user hits the site (which is, of course, optional), execute
  81
  82  bin/touch-views.sh
  83
  84
  85
  86 Settings
  87 --------
  88
  89 Check the settings in mygpo/settings.py. If you want to change any settings,
  90 add them to mygpo/settings_prod.py with the correct value.
  91
  92
  93
  94 Web-Server
  95 ----------
  96
  97 Django comes with a development webservice which you can run from the mygpo
  98 directory with
  99
 100   python manage.py runserver
 101
 102 If you want to run a production server, check out
 103
 104  https://docs.djangoproject.com/en/dev/howto/deployment/
 105
 106
 107