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