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
  25 0.5.0
  26 =====
  27
  28 **Do this to upgrade**
  29
  30 1. Make sure to run
  31    ``./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate``
  32    after upgrading.
  33
  34 .. mention something about new, experimental configure && make support
  35
  36 2. Note that a couple of things have changed with ``mediagoblin.ini``. First
  37    we have a new Authentication System. You need to add
  38    ``[[mediagoblin.plugins.basic_auth]]`` under the ``[plugins]`` section of
  39    your config file. Second, media types are now plugins, so you need to add
  40    each media type under the ``[plugins]`` section of your config file.
  41
  42
  43 3. We have made a script to transition your ``mediagoblin_local.ini`` file for
  44    you. This script can be found at
  45
  46 .. add a link to the script
  47
  48 If you run into problems, don't hesitate to
  49 `contact us <http://mediagoblin.org/pages/join.html>`_
  50 (IRC is often best).
  51
  52 **New features**
  53
  54 * As mentioned above, we now have a plugable Authentication system. You can
  55   use any combination of the multiple authentication systems
  56   (:ref:`basic_auth-chapter`, :ref:`persona-chapter`, :ref:`openid-chapter`)
  57   or write your own!
  58 * Media types are now plugins!  This means that new media types will
  59   be able to do new, fancy things they couldn't in the future.
  60 * We now have notification support! This allows you to subscribe to media
  61   comments and to be notified when someone comments on your media.
  62 * New reprocessing framework! You can now reprocess failed uploads, and
  63   send already processed media back to processing to re-transcode or resize
  64   media.
  65 * Comment preview!
  66 * Users now have the ability to change their email associated with their
  67   account.
  68 * New oauth code as we move closer to federation support.
  69 * Experimental pyconfigure support for GNU-style configue and makefile
  70   deployment.
  71 * Database foundations! You can now pre-populate the database models.
  72 * Way faster unit test run-time via in-memory database.
  73 * All mongokit stuff has been cleaned up.
  74 * Fixes for non-ascii filenames.
  75 * The option to stay logged in.
  76 * Mediagoblin has been upgraded to use the latest `celery <http://celeryproject.org/>`_
  77   version.
  78 * You can now add jinja2 extensions to your config file to use in custom
  79   templates.
  80 * Fixed video permission issues.
  81 * Mediagoblin docs are now hosted with multiple versions.
  82 * We removed redundent tooltips from the STL media display.
  83 * We are now using itsdangerous for verification tokens.
  84
  85
  86 0.4.1
  87 =====
  88
  89 This is a bugfix release for 0.4.0.  This only implements one major
  90 fix in the newly released document support which prevented the
  91 "conversion via libreoffice" feature.
  92
  93 If you were running 0.4.0 you can upgrade to v0.4.1 via a simple
  94 switch and restarting mediagoblin/celery with no other actions.
  95
  96 Otherwise, follow 0.4.0 instructions.
  97
  98
  99 0.4.0
 100 =====
 101
 102 **Do this to upgrade**
 103
 104 1. Make sure to run
 105    ``./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate``
 106    after upgrading.
 107 2. See "For Theme authors" if you have a custom theme.
 108 3. Note that ``./bin/gmg theme assetlink`` is now just
 109    ``./bin/gmg assetlink`` and covers both plugins and assets.
 110    Keep on reading to hear more about new plugin features.
 111 4. If you want to take advantage of new plugins that have statically
 112    served assets, you are going to need to add the new "plugin_static"
 113    section to your nginx config.  Basically the following for nginx::
 114
 115      # Plugin static files (usually symlinked in)
 116      location /plugin_static/ {
 117         alias /srv/mediagoblin.example.org/mediagoblin/user_dev/plugin_static/;
 118      }
 119
 120    Similarly, if you've got a modified paste config, you may want to
 121    borrow the app:plugin_static section from the default paste.ini
 122    file.
 123 5. We now use itsdangerous for sessions; if you had any references to
 124    beaker in your paste config you can remove them.  Again, see the
 125    default paste.ini config
 126 6. We also now use git submodules.  Please do:
 127    ``git submodule init && git submodule update``
 128    You will need to do this to use the new PDF support.
 129
 130 **For theme authors**
 131
 132 If you have your own theme or you have any "user modified templates",
 133 please note the following:
 134
 135 * mediagoblin/bits/ files above-content.html, body-end.html,
 136   body-start.html now are renamed... they have underscores instead of
 137   dashes in the filenames now :)
 138 * There's a new file: ``mediagoblin/bits/frontpage_welcome.html``.
 139   You can easily customize this to give a welcome page appropriate to
 140   your site.
 141
 142
 143 **New features**
 144 * PDF media type!
 145 * Improved plugin system.  More flexible, better documented, with a
 146   new plugin authoring section of the docs.
 147 * itsdangerous based sessions.  No more beaker!
 148 * New, experimental Piwigo-based API.  This means you should be able
 149   to use MediaGoblin with something like Shotwell.  (Again, a word of
 150   caution: this is *very experimental*!)
 151 * Human readable timestamps, and the option to display the original
 152   date of an image when available (available as the
 153   "original_date_visible" variable)
 154 * Moved unit testing system from nosetests to py.test so we can better
 155   handle issues with sqlalchemy exploding with different database
 156   configurations.  Long story :)
 157 * You can now disable the ability to post comments.
 158 * Tags now can be up to length 255 characters by default.
 159
 160
 161 0.3.3
 162 =====
 163
 164 **Do this to upgrade**
 165
 166 1. Make sure to run ``bin/gmg dbupdate`` after upgrading.
 167 2. OpenStreetMap is now a plugin, so if you want to use it, add the
 168    following to your config file:
 169
 170    .. code-block:: ini
 171
 172     [plugins]
 173     [[mediagoblin.plugins.geolocation]]
 174
 175 If you have your own theme, you may need to make some adjustments to
 176 it as some theme related things may have changed in this release.  If
 177 you run into problems, don't hesitate to
 178 `contact us <http://mediagoblin.org/pages/join.html>`_
 179 (IRC is often best).
 180
 181 **New features**
 182
 183 * New dropdown menu for accessing various features.
 184
 185 * Significantly improved URL generation.  Now mediagoblin won't give
 186   up on making a slug if it looks like there will be a duplicate;
 187   it'll try extra hard to generate a meaningful one instead.
 188
 189   Similarly, linking to an id no longer can possibly conflict with
 190   linking to a slug; /u/username/m/id:35/ is the kind of reference we
 191   now use to linking to entries with ids.  However, old links with
 192   entries that linked to ids should work just fine with our migration.
 193   The only urls that might break in this release are ones using colons
 194   or equal signs.
 195
 196 * New template hooks for plugin authoring.
 197
 198 * As a demonstration of new template hooks for plugin authoring,
 199   openstreetmap support now moved to a plugin!
 200
 201 * Method to add media to collections switched from icon of paperclip
 202   to button with "add to collection" text.
 203
 204 * Bug where videos often failed to produce a proper thumbnail fixed!
 205
 206 * Copying around files in MediaGoblin now much more efficient, doesn't
 207   waste gobs of memory.
 208
 209 * Video transcoding now optional for videos that meet certain
 210   criteria.  By default, MediaGoblin will not transcode webm videos
 211   that are smaller in resolution than the MediaGoblin defaults, and
 212   MediaGoblin can also be configured to allow theora files to not be
 213   transcoded as well.
 214
 215 * Per-user license preference option; always want your uploads to be
 216   BY-SA and tired of changing that field?  You can now set your
 217   license preference in your user settings.
 218
 219 * Video player now responsive; better for mobile!
 220
 221 * You can now delete your account from the user preferences page if
 222   you so wish.
 223
 224 **Other changes**
 225
 226 * Plugin writers: Internal restructuring led to mediagoblin.db.sql* be
 227   mediagoblin.db.* starting from 0.3.3
 228
 229 * Dependency list has been reduced not requiring the "webob" package anymore.
 230
 231 * And many small fixes/improvements, too numerous to list!
 232
 233
 234 0.3.2
 235 =====
 236
 237 This will be the last release that is capable of converting from an earlier
 238 MongoDB-based MediaGoblin instance to the newer SQL-based system.
 239
 240 **Do this to upgrade**
 241
 242     # directory of your mediagoblin install
 243     cd /srv/mediagoblin.example.org
 244
 245     # copy source for this release
 246     git fetch
 247     git checkout tags/v0.3.2
 248
 249     # perform any needed database updates
 250     bin/gmg dbupdate
 251
 252     # restart your servers however you do that, e.g.,
 253     sudo service mediagoblin-paster restart
 254     sudo service mediagoblin-celeryd restart
 255
 256
 257 **New features**
 258
 259 * **3d model support!**
 260
 261   You can now upload STL and OBJ files and display them in
 262   MediaGoblin.  Requires a recent-ish Blender; for details see:
 263   :ref:`deploying-chapter`
 264
 265 * **trim_whitespace**
 266
 267   We bundle the optional plugin trim_whitespace which reduces the size
 268   of the delivered html output by reducing redundant whitespace.
 269
 270   See :ref:`core-plugin-section` for plugin documentation
 271
 272 * **A new API!**
 273
 274   It isn't well documented yet but we do have an API.  There is an
 275   `android application in progress <https://gitorious.org/mediagoblin/mediagoblin-android>`_
 276   which makes use of it, and there are some demo applications between
 277   `automgtic <https://github.com/jwandborg/automgtic>`_, an
 278   automatic media uploader for your desktop
 279   and `OMGMG <https://github.com/jwandborg/omgmg>`_, an example of
 280   a web application hooking up to the API.
 281
 282   This is a plugin, so you have to enable it in your mediagoblin
 283   config file by adding a section under [plugins] like::
 284
 285     [plugins]
 286     [[mediagoblin.plugins.api]]
 287
 288   Note that the API works but is not nailed down... the way it is
 289   called may change in future releases.
 290
 291 * **OAuth login support**
 292
 293   For applications that use OAuth to connect to the API.
 294
 295   This is a plugin, so you have to enable it in your mediagoblin
 296   config file by adding a section under [plugins] like::
 297
 298     [plugins]
 299     [[mediagoblin.plugins.oauth]]
 300
 301 * **Collections**
 302
 303   We now have user-curated collections support.  These are arbitrary
 304   galleries that are customizable by users.  You can add media to
 305   these by clicking on the paperclip icon when logged in and looking
 306   at a media entry.
 307
 308 * **OpenStreetMap licensing display improvements**
 309
 310   More accurate display of OSM licensing, and less disruptive: you
 311   click to "expand" the display of said licensing.
 312
 313   Geolocation is also now on by default.
 314
 315 * **Miscelaneous visual improvements**
 316
 317   We've made a number of small visual improvements including newer and
 318   nicer looking thumbnails and improved checkbox placement.
 319
 320
 321
 322 0.3.1
 323 =====
 324
 325 **Do this to upgrade**
 326
 327 1. Make sure to run ``bin/gmg dbuptdate`` after upgrading.
 328
 329 2. If you set up your server config with an older version of
 330    mediagoblin and the mediagoblin docs, it's possible you don't
 331    have the "theme static files" alias, so double check to make
 332    sure that section is there if you are having problems.
 333
 334
 335
 336 **New features**
 337
 338 * **theming support**
 339
 340   MediaGoblin now also includes theming support, which you can
 341   read about in the section :ref:`theming-chapter`.
 342
 343 * **flatpages**
 344
 345   MediaGoblin has a flatpages plugin allowing you to add pages that
 346   are aren't media-related like "About this site...", "Terms of
 347   service...", etc.
 348
 349   See :ref:`core-plugin-section` for plugin documentation
 350
 351
 352 0.3.0
 353 =====
 354
 355 This release has one important change. You need to act when
 356 upgrading from a previous version!
 357
 358 This release changes the database system from MongoDB to
 359 SQL(alchemy). If you want to setup a fresh instance, just
 360 follow the instructions in the deployment chapter. If on
 361 the other hand you want to continue to use one instance,
 362 read on.
 363
 364 To convert your data from MongoDB to SQL(alchemy), you need
 365 to follow these steps:
 366
 367 1. Make sure your MongoDB is still running and has your
 368    data, it's needed for the conversion.
 369
 370 2. Configure the ``sql_engine`` URI in the config to represent
 371    your target database (see: :ref:`deploying-chapter`)
 372
 373 3. You need an empty database.
 374
 375 4. Then run the following command::
 376
 377        bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql
 378
 379 5. Start your server and investigate.
 380
 381 6. That's it.