25d4d83ff67f184213dc2bb2979219d69307d0bd
[mediagoblin.git] / 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.2
23 =====
24
25 This will be the last release that is capable of converting from an earlier
26 MongoDB-based MediaGoblin instance to the newer SQL-based system.
27
28 **Do this to upgrade**
29
30 1. Make sure to run ``bin/gmg dbupdate`` after upgrading.
31
32
33 **New features**
34
35 * **3d model support!**
36
37 You can now upload STL and OBJ files and display them in
38 MediaGoblin. Requires a recent-ish Blender; for details see:
39 :ref:`deploying-chapter`
40
41 * **trim_whitespace**
42
43 We bundle the optional plugin trim_whitespace which reduces the size
44 of the delivered html output by reducing redundant whitespace.
45
46 See :ref:`core-plugin-section` for plugin documentation
47
48 * **A new API!**
49
50 It isn't well documented yet but we do have an API. There is an
51 `android application in progress <https://gitorious.org/mediagoblin/mediagoblin-android>`_
52 which makes use of it, and there are some demo applications between
53 `automgtic <https://github.com/jwandborg/automgtic>`_, an
54 automatic media uploader for your desktop
55 and `OMGMG <https://github.com/jwandborg/omgmg>`_, an example of
56 a web application hooking up to the API.
57
58 This is a plugin, so you have to enable it in your mediagoblin
59 config file by adding a section under [plugins] like::
60
61 [plugins]
62 [[mediagoblin.plugins.api]]
63
64 Note that the API works but is not nailed down... the way it is
65 called may change in future releases.
66
67 * **OAuth login support**
68
69 For applications that use OAuth to connect to the API.
70
71 This is a plugin, so you have to enable it in your mediagoblin
72 config file by adding a section under [plugins] like::
73
74 [plugins]
75 [[mediagoblin.plugins.oauth]]
76
77 * **Collections**
78
79 We now have user-curated collections support. These are arbitrary
80 galleries that are customizable by users. You can add media to
81 these by clicking on the paperclip icon when logged in and looking
82 at a media entry.
83
84 * **OpenStreetMap licensing display improvements**
85
86 More accurate display of OSM licensing, and less disruptive: you
87 click to "expand" the display of said licensing.
88
89 Geolocation is also now on by default.
90
91 * **Miscelaneous visual improvements**
92
93 We've made a number of small visual improvements including newer and
94 nicer looking thumbnails and improved checkbox placement.
95
96
97
98 0.3.1
99 =====
100
101 **Do this to upgrade**
102
103 1. Make sure to run ``bin/gmg dbuptdate`` after upgrading.
104
105 2. If you set up your server config with an older version of
106 mediagoblin and the mediagoblin docs, it's possible you don't
107 have the "theme static files" alias, so double check to make
108 sure that section is there if you are having problems.
109
110
111
112 **New features**
113
114 * **theming support**
115
116 MediaGoblin now also includes theming support, which you can
117 read about in the section :ref:`theming-chapter`.
118
119 * **flatpages**
120
121 MediaGoblin has a flatpages plugin allowing you to add pages that
122 are aren't media-related like "About this site...", "Terms of
123 service...", etc.
124
125 See :ref:`core-plugin-section` for plugin documentation
126
127
128 0.3.0
129 =====
130
131 This release has one important change. You need to act when
132 upgrading from a previous version!
133
134 This release changes the database system from MongoDB to
135 SQL(alchemy). If you want to setup a fresh instance, just
136 follow the instructions in the deployment chapter. If on
137 the other hand you want to continue to use one instance,
138 read on.
139
140 To convert your data from MongoDB to SQL(alchemy), you need
141 to follow these steps:
142
143 1. Make sure your MongoDB is still running and has your
144 data, it's needed for the conversion.
145
146 2. Configure the ``sql_engine`` URI in the config to represent
147 your target database (see: :ref:`deploying-chapter`)
148
149 3. You need an empty database.
150
151 4. Then run the following command::
152
153 bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql
154
155 5. Start your server and investigate.
156
157 6. That's it.