Merge remote-tracking branch 'cwebber/254_delete_queue_directories'
[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.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 1. Make sure to run ``bin/gmg dbupdate`` after upgrading.
104
105
106 **New features**
107
108 * **3d model support!**
109
110 You can now upload STL and OBJ files and display them in
111 MediaGoblin. Requires a recent-ish Blender; for details see:
112 :ref:`deploying-chapter`
113
114 * **trim_whitespace**
115
116 We bundle the optional plugin trim_whitespace which reduces the size
117 of the delivered html output by reducing redundant whitespace.
118
119 See :ref:`core-plugin-section` for plugin documentation
120
121 * **A new API!**
122
123 It isn't well documented yet but we do have an API. There is an
124 `android application in progress <https://gitorious.org/mediagoblin/mediagoblin-android>`_
125 which makes use of it, and there are some demo applications between
126 `automgtic <https://github.com/jwandborg/automgtic>`_, an
127 automatic media uploader for your desktop
128 and `OMGMG <https://github.com/jwandborg/omgmg>`_, an example of
129 a web application hooking up to the API.
130
131 This is a plugin, so you have to enable it in your mediagoblin
132 config file by adding a section under [plugins] like::
133
134 [plugins]
135 [[mediagoblin.plugins.api]]
136
137 Note that the API works but is not nailed down... the way it is
138 called may change in future releases.
139
140 * **OAuth login support**
141
142 For applications that use OAuth to connect to the API.
143
144 This is a plugin, so you have to enable it in your mediagoblin
145 config file by adding a section under [plugins] like::
146
147 [plugins]
148 [[mediagoblin.plugins.oauth]]
149
150 * **Collections**
151
152 We now have user-curated collections support. These are arbitrary
153 galleries that are customizable by users. You can add media to
154 these by clicking on the paperclip icon when logged in and looking
155 at a media entry.
156
157 * **OpenStreetMap licensing display improvements**
158
159 More accurate display of OSM licensing, and less disruptive: you
160 click to "expand" the display of said licensing.
161
162 Geolocation is also now on by default.
163
164 * **Miscelaneous visual improvements**
165
166 We've made a number of small visual improvements including newer and
167 nicer looking thumbnails and improved checkbox placement.
168
169
170
171 0.3.1
172 =====
173
174 **Do this to upgrade**
175
176 1. Make sure to run ``bin/gmg dbuptdate`` after upgrading.
177
178 2. If you set up your server config with an older version of
179 mediagoblin and the mediagoblin docs, it's possible you don't
180 have the "theme static files" alias, so double check to make
181 sure that section is there if you are having problems.
182
183
184
185 **New features**
186
187 * **theming support**
188
189 MediaGoblin now also includes theming support, which you can
190 read about in the section :ref:`theming-chapter`.
191
192 * **flatpages**
193
194 MediaGoblin has a flatpages plugin allowing you to add pages that
195 are aren't media-related like "About this site...", "Terms of
196 service...", etc.
197
198 See :ref:`core-plugin-section` for plugin documentation
199
200
201 0.3.0
202 =====
203
204 This release has one important change. You need to act when
205 upgrading from a previous version!
206
207 This release changes the database system from MongoDB to
208 SQL(alchemy). If you want to setup a fresh instance, just
209 follow the instructions in the deployment chapter. If on
210 the other hand you want to continue to use one instance,
211 read on.
212
213 To convert your data from MongoDB to SQL(alchemy), you need
214 to follow these steps:
215
216 1. Make sure your MongoDB is still running and has your
217 data, it's needed for the conversion.
218
219 2. Configure the ``sql_engine`` URI in the config to represent
220 your target database (see: :ref:`deploying-chapter`)
221
222 3. You need an empty database.
223
224 4. Then run the following command::
225
226 bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql
227
228 5. Start your server and investigate.
229
230 6. That's it.