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