docs/source/siteadmin/relnotes.rst

   1 .. MediaGoblin Documentation
   2
   3    Written in 2012 by MediaGoblin contributors
   4
   5    To the extent possible under law, the author(s) have dedicated all
   6    copyright and related and neighboring rights to this software to
   7    the public domain worldwide. This software is distributed without
   8    any warranty.
   9
  10    You should have received a copy of the CC0 Public Domain
  11    Dedication along with this software. If not, see
  12    <http://creativecommons.org/publicdomain/zero/1.0/>.
  13
  14 =============
  15 Release Notes
  16 =============
  17
  18 This chapter has important information for releases in it.
  19 If you're upgrading from a previous release, please read it
  20 carefully, or at least skim over it.
  21
  22 0.3.3
  23 =====
  24
  25 **Do this to upgrade**
  26
  27 1. Make sure to run ``bin/gmg dbupdate`` after upgrading.
  28 2. OpenStreetMap is now a plugin, so if you want to use it, add the
  29    following to your config file:
  30
  31    .. code-block:: ini
  32
  33       [plugins]
  34       [[mediagoblin.plugins.geolocation]]
  35
  36 If you have your own theme, you may need to make some adjustments to
  37 it as some theme related things may have changed in this release.  If
  38 you run into problems, don't hesitate to
  39 `contact us <http://mediagoblin.org/pages/join.html>`_
  40 (IRC is often best).
  41
  42 **New features**
  43
  44 * New dropdown menu for accessing various features.
  45
  46 * Significantly improved URL generation.  Now mediagoblin won't give
  47   up on making a slug if it looks like there will be a duplicate;
  48   it'll try extra hard to generate a meaningful one instead.
  49
  50   Similarly, linking to an id no longer can possibly conflict with
  51   linking to a slug; /u/username/m/id:35/ is the kind of reference we
  52   now use to linking to entries with ids.  However, old links with
  53   entries that linked to ids should work just fine with our migration.
  54   The only urls that might break in this release are ones using colons
  55   or equal signs.
  56
  57 * New template hooks for plugin authoring.
  58
  59 * As a demonstration of new template hooks for plugin authoring,
  60   openstreetmap support now moved to a plugin!
  61
  62 * Method to add media to collections switched from icon of paperclip
  63   to button with "add to collection" text.
  64
  65 * Bug where videos often failed to produce a proper thumbnail fixed!
  66
  67 * Copying around files in MediaGoblin now much more efficient, doesn't
  68   waste gobs of memory.
  69
  70 * Video transcoding now optional for videos that meet certain
  71   criteria.  By default, MediaGoblin will not transcode webm videos
  72   that are smaller in resolution than the MediaGoblin defaults, and
  73   MediaGoblin can also be configured to allow theora files to not be
  74   transcoded as well.
  75
  76 * Per-user license preference option; always want your uploads to be
  77   BY-SA and tired of changing that field?  You can now set your
  78   license preference in your user settings.
  79
  80 * Video player now responsive; better for mobile!
  81
  82 * You can now delete your account from the user preferences page if
  83   you so wish.
  84
  85 **Other changes**
  86
  87 * Plugin writers: Internal restructuring led to mediagoblin.db.sql* be
  88   mediagoblin.db.* starting from 0.3.3
  89
  90 * Dependency list has been reduced not requiring the "webob" package anymore.
  91
  92 * And many small fixes/improvements, too numerous to list!
  93
  94
  95 0.3.2
  96 =====
  97
  98 This will be the last release that is capable of converting from an earlier
  99 MongoDB-based MediaGoblin instance to the newer SQL-based system.
 100
 101 **Do this to upgrade**
 102
 103     # directory of your mediagoblin install
 104     cd /srv/mediagoblin.example.org
 105
 106     # copy source for this release
 107     git fetch
 108     git checkout tags/v0.3.2
 109
 110     # perform any needed database updates
 111     bin/gmg dbupdate
 112
 113     # restart your servers however you do that, e.g.,
 114     sudo service mediagoblin-paster restart
 115     sudo service mediagoblin-celeryd restart
 116
 117
 118 **New features**
 119
 120 * **3d model support!**
 121
 122   You can now upload STL and OBJ files and display them in
 123   MediaGoblin.  Requires a recent-ish Blender; for details see:
 124   :ref:`deploying-chapter`
 125
 126 * **trim_whitespace**
 127
 128   We bundle the optional plugin trim_whitespace which reduces the size
 129   of the delivered html output by reducing redundant whitespace.
 130
 131   See :ref:`core-plugin-section` for plugin documentation
 132
 133 * **A new API!**
 134
 135   It isn't well documented yet but we do have an API.  There is an
 136   `android application in progress <https://gitorious.org/mediagoblin/mediagoblin-android>`_
 137   which makes use of it, and there are some demo applications between
 138   `automgtic <https://github.com/jwandborg/automgtic>`_, an
 139   automatic media uploader for your desktop
 140   and `OMGMG <https://github.com/jwandborg/omgmg>`_, an example of
 141   a web application hooking up to the API.
 142
 143   This is a plugin, so you have to enable it in your mediagoblin
 144   config file by adding a section under [plugins] like::
 145
 146     [plugins]
 147     [[mediagoblin.plugins.api]]
 148
 149   Note that the API works but is not nailed down... the way it is
 150   called may change in future releases.
 151
 152 * **OAuth login support**
 153
 154   For applications that use OAuth to connect to the API.
 155
 156   This is a plugin, so you have to enable it in your mediagoblin
 157   config file by adding a section under [plugins] like::
 158
 159     [plugins]
 160     [[mediagoblin.plugins.oauth]]
 161
 162 * **Collections**
 163
 164   We now have user-curated collections support.  These are arbitrary
 165   galleries that are customizable by users.  You can add media to
 166   these by clicking on the paperclip icon when logged in and looking
 167   at a media entry.
 168
 169 * **OpenStreetMap licensing display improvements**
 170
 171   More accurate display of OSM licensing, and less disruptive: you
 172   click to "expand" the display of said licensing.
 173
 174   Geolocation is also now on by default.
 175
 176 * **Miscelaneous visual improvements**
 177
 178   We've made a number of small visual improvements including newer and
 179   nicer looking thumbnails and improved checkbox placement.
 180
 181
 182
 183 0.3.1
 184 =====
 185
 186 **Do this to upgrade**
 187
 188 1. Make sure to run ``bin/gmg dbuptdate`` after upgrading.
 189
 190 2. If you set up your server config with an older version of
 191    mediagoblin and the mediagoblin docs, it's possible you don't
 192    have the "theme static files" alias, so double check to make
 193    sure that section is there if you are having problems.
 194
 195
 196
 197 **New features**
 198
 199 * **theming support**
 200
 201   MediaGoblin now also includes theming support, which you can
 202   read about in the section :ref:`theming-chapter`.
 203
 204 * **flatpages**
 205
 206   MediaGoblin has a flatpages plugin allowing you to add pages that
 207   are aren't media-related like "About this site...", "Terms of
 208   service...", etc.
 209
 210   See :ref:`core-plugin-section` for plugin documentation
 211
 212
 213 0.3.0
 214 =====
 215
 216 This release has one important change. You need to act when
 217 upgrading from a previous version!
 218
 219 This release changes the database system from MongoDB to
 220 SQL(alchemy). If you want to setup a fresh instance, just
 221 follow the instructions in the deployment chapter. If on
 222 the other hand you want to continue to use one instance,
 223 read on.
 224
 225 To convert your data from MongoDB to SQL(alchemy), you need
 226 to follow these steps:
 227
 228 1. Make sure your MongoDB is still running and has your
 229    data, it's needed for the conversion.
 230
 231 2. Configure the ``sql_engine`` URI in the config to represent
 232    your target database (see: :ref:`deploying-chapter`)
 233
 234 3. You need an empty database.
 235
 236 4. Then run the following command::
 237
 238        bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql
 239
 240 5. Start your server and investigate.
 241
 242 6. That's it.