INSTALL

   1
   2
   3                    Deployment instructions for gpodder.net
   4                    ---------------------------------------
   5
   6
   7 Please note that this deployment instructions apply to the current couchdb
   8 branch of mygpo/gpodder.net only. They will change once the migration to
   9 CouchDB has been completed.
  10
  11
  12   Dependencies
  13 ================
  14
  15 When no version number is indicated, it is advisable to install the current
  16 development version from the repository.
  17
  18   * python (>= 2.6)
  19   * MySQL Server (>= 5.0)
  20   * CouchDB (>= 1.0, incl Patch from [1])
  21   * python-mysqldb [2]
  22   * lighttpd (>= 1.4.19)
  23   * python-feedparser [3] or [4]
  24   * python-dateutil [5]
  25   * python-flup [6]
  26   * python-imaging [7]
  27   * python-pybabel [8]
  28   * couchdbkit [9]
  29   * Django (>= 1.2.2, [10])
  30   * django-registration [11]
  31
  32
  33   MySQL
  34 =========
  35
  36 1. Updating the Settings
  37
  38 In mygpo/settings.py a skeleton database setting (DATABASES) is provided.  To
  39 use mygpo with a MySQL database, create settings_prod.py and overwrite the
  40 settings with something like
  41
  42 DATABASES = {
  43     'default': {
  44         'NAME': 'mygpo',
  45         'ENGINE': 'django.db.backends.mysql',
  46         'USER': 'mygpo',
  47         'PASSWORD': '',
  48     }
  49 }
  50
  51 The following instructions will be based on these settings but you are free to
  52 adapt them.
  53
  54
  55 2. Creating the database
  56
  57 In MySQL, do the following (the SUPER grant is needed for
  58 triggers to work in MySQL 5.0):
  59
  60   CREATE DATABASE mygpo;
  61   GRANT ALL ON mygpo.* TO mygpo@localhost WITH GRANT OPTION;
  62   GRANT SUPER ON *.* TO mygpo@localhost;
  63   GRANT ALL ON mygpo.* TO mygpo@'%' WITH GRANT OPTION;
  64   GRANT SUPER ON *.* TO mygpo@'%';
  65   FLUSH PRIVILEGES;
  66
  67 Make sure that MySQL listens only on localhost, or if in
  68 doubt, assign a password to the "mygpo" user!
  69
  70
  71 3. Initializing an empty Database
  72
  73 You can skip this step if you are importing a dump.
  74
  75 Run in the mygpo/ subdirectory (possibly after setting the
  76 DB parameters in mygpo/settings.py):
  77
  78   python manage.py syncdb
  79
  80 When asked to create a superuser, you can say YES.
  81
  82 Now, run every SQL-Script in the install/ subdirectory, starting
  83 with "create.sql" and working your way all the way through the
  84 update scripts (these are split because we are doing incremental
  85 schema updates on the production server).
  86
  87 If you are really doing an initial installation, you can also use
  88 the "install.sh" script which runs all scripts on the local MySQL
  89 server in the correct order. You should not use this script to
  90 upgrade the database, as data loss may occur. You have been warned.
  91
  92
  93 4. Importing a Dump
  94
  95 A dump contains both the database structure and the data. You can import it
  96 with
  97
  98   gunzip -c <dumpfile>.sql.gz | mysql -uroot -p mygpo
  99
 100
 101   CouchDB
 102 ===========
 103
 104 1. Initializing an empty Database
 105
 106 To create the database, execute the following on the commandline
 107
 108   curl -X PUT http://127.0.0.1:5984/mygpo
 109
 110 To initialize the views, execute from the mygpo-Directory
 111
 112   python manage.py syncdb
 113
 114
 115 2. Importing a Dump
 116
 117 To import a CouchDB dump, execute the following from the commandline
 118
 119   gunzip -c <dumpfile.couch.gz> | couchdb-load http://127.0.0.1:5984/mygpo
 120
 121
 122 3. Building the Views
 123
 124 On the first request, CouchDB will build the views. To do this before the first
 125 user hits the site (which is, of course, optional), execute the following
 126
 127   curl -X GET http://127.0.0.1:5984/mygpo/_design/core/_view/podcasts_by_url?limit=1
 128   curl -X GET http://127.0.0.1:5984/mygpo/_design/directory/_view/toplist
 129
 130
 131   Web-Server
 132 ==============
 133
 134 Django comes with a development webservice which you can run from the mygpo
 135 directory with
 136
 137   python manage.py runserver
 138
 139 If you want to run a production server, you can set up lighttpd instead
 140
 141 There is a mygpo.lighttpd.conf file shipped with the source. Please
 142 customize it to your needs, and then include it from your lighttpd
 143 main configuration file, for example like this:
 144
 145   include "/srv/mygpo/mygpo.lighttpd.conf"
 146
 147 The modules you need to enable are: rewrite, fastcgi. On Debian,
 148 you can enable these using the "lighty-enable-mod" command:
 149
 150   lighty-enable-mod rewrite fastcgi
 151
 152 Then restart ligghtd with
 153
 154   /etc/init.d/lighttpd restart
 155
 156
 157   Settings
 158 ============
 159
 160 Check the settings in mygpo/settings.py. If you want to change any settings,
 161 add them to mygpo/settings_prod.py with the correct value.
 162
 163
 164
 165   References
 166 ==============
 167
 168  [1]  http://mail-archives.apache.org/mod_mbox/couchdb-dev/201010.mbox/<24594469.51751287512786814.JavaMail.jira@thor>
 169  [2]  http://sourceforge.net/projects/mysql-python/
 170  [3]  http://feedparser.org/
 171  [4]  https://github.com/kurtmckee/feedparser/
 172  [5]  http://niemeyer.net/python-dateutil
 173  [6]  http://trac.saddi.com/flup
 174  [7]  http://www.pythonware.com/products/pil/
 175  [8]  http://babel.edgewall.org/
 176  [9]  https://github.com/stefankoegl/couchdbkit
 177  [10] http://www.djangoproject.com/
 178  [11] https://bitbucket.org/ubernostrum/django-registration/
 179