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