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