Commit | Line | Data |
---|---|---|
5be6425c E |
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 | ||
8ca51d32 CAW |
22 | 0.4.0 |
23 | ===== | |
24 | ||
25 | **For theme authors** | |
26 | ||
27 | If you have your own theme or you have any "user modified templates", | |
28 | please note the following: | |
29 | ||
30 | * mediagoblin/bits/ files above-content.html, body-end.html, | |
31 | body-start.html now are renamed... they have underscores instead of | |
32 | dashes in the filenames now :) | |
33 | * There's a new file: ``mediagoblin/bits/frontpage_welcome.html``. | |
34 | You can easily customize this to give a welcome page appropriate to | |
35 | your site. | |
36 | ||
37 | ||
6e2dcbff | 38 | 0.3.3 |
8d19cb24 SS |
39 | ===== |
40 | ||
6e2dcbff CAW |
41 | **Do this to upgrade** |
42 | ||
43 | 1. Make sure to run ``bin/gmg dbupdate`` after upgrading. | |
44 | 2. OpenStreetMap is now a plugin, so if you want to use it, add the | |
997ef976 | 45 | following to your config file: |
6e2dcbff | 46 | |
997ef976 E |
47 | .. code-block:: ini |
48 | ||
49 | [plugins] | |
50 | [[mediagoblin.plugins.geolocation]] | |
6e2dcbff CAW |
51 | |
52 | If you have your own theme, you may need to make some adjustments to | |
a28c6c4c CAW |
53 | it as some theme related things may have changed in this release. If |
54 | you run into problems, don't hesitate to | |
55 | `contact us <http://mediagoblin.org/pages/join.html>`_ | |
56 | (IRC is often best). | |
6e2dcbff | 57 | |
8d19cb24 SS |
58 | **New features** |
59 | ||
6e2dcbff CAW |
60 | * New dropdown menu for accessing various features. |
61 | ||
62 | * Significantly improved URL generation. Now mediagoblin won't give | |
63 | up on making a slug if it looks like there will be a duplicate; | |
64 | it'll try extra hard to generate a meaningful one instead. | |
65 | ||
66 | Similarly, linking to an id no longer can possibly conflict with | |
67 | linking to a slug; /u/username/m/id:35/ is the kind of reference we | |
68 | now use to linking to entries with ids. However, old links with | |
69 | entries that linked to ids should work just fine with our migration. | |
70 | The only urls that might break in this release are ones using colons | |
71 | or equal signs. | |
72 | ||
73 | * New template hooks for plugin authoring. | |
74 | ||
75 | * As a demonstration of new template hooks for plugin authoring, | |
76 | openstreetmap support now moved to a plugin! | |
77 | ||
a28c6c4c CAW |
78 | * Method to add media to collections switched from icon of paperclip |
79 | to button with "add to collection" text. | |
6e2dcbff CAW |
80 | |
81 | * Bug where videos often failed to produce a proper thumbnail fixed! | |
82 | ||
fda5ea7a | 83 | * Copying around files in MediaGoblin now much more efficient, doesn't |
6e2dcbff CAW |
84 | waste gobs of memory. |
85 | ||
86 | * Video transcoding now optional for videos that meet certain | |
fda5ea7a CAW |
87 | criteria. By default, MediaGoblin will not transcode webm videos |
88 | that are smaller in resolution than the MediaGoblin defaults, and | |
89 | MediaGoblin can also be configured to allow theora files to not be | |
a28c6c4c | 90 | transcoded as well. |
6e2dcbff CAW |
91 | |
92 | * Per-user license preference option; always want your uploads to be | |
93 | BY-SA and tired of changing that field? You can now set your | |
94 | license preference in your user settings. | |
95 | ||
96 | * Video player now responsive; better for mobile! | |
97 | ||
70177c1f CAW |
98 | * You can now delete your account from the user preferences page if |
99 | you so wish. | |
100 | ||
a28c6c4c | 101 | **Other changes** |
8d19cb24 | 102 | |
b0c8328e SS |
103 | * Plugin writers: Internal restructuring led to mediagoblin.db.sql* be |
104 | mediagoblin.db.* starting from 0.3.3 | |
105 | ||
6e2dcbff CAW |
106 | * Dependency list has been reduced not requiring the "webob" package anymore. |
107 | ||
108 | * And many small fixes/improvements, too numerous to list! | |
109 | ||
8d19cb24 | 110 | |
cacb6fea SS |
111 | 0.3.2 |
112 | ===== | |
113 | ||
114 | This will be the last release that is capable of converting from an earlier | |
115 | MongoDB-based MediaGoblin instance to the newer SQL-based system. | |
116 | ||
1f01df1d CAW |
117 | **Do this to upgrade** |
118 | ||
42ce372e ML |
119 | # directory of your mediagoblin install |
120 | cd /srv/mediagoblin.example.org | |
121 | ||
122 | # copy source for this release | |
123 | git fetch | |
124 | git checkout tags/v0.3.2 | |
125 | ||
126 | # perform any needed database updates | |
127 | bin/gmg dbupdate | |
128 | ||
129 | # restart your servers however you do that, e.g., | |
130 | sudo service mediagoblin-paster restart | |
131 | sudo service mediagoblin-celeryd restart | |
1f01df1d | 132 | |
cacb6fea SS |
133 | |
134 | **New features** | |
135 | ||
1f01df1d CAW |
136 | * **3d model support!** |
137 | ||
138 | You can now upload STL and OBJ files and display them in | |
139 | MediaGoblin. Requires a recent-ish Blender; for details see: | |
140 | :ref:`deploying-chapter` | |
cacb6fea SS |
141 | |
142 | * **trim_whitespace** | |
143 | ||
144 | We bundle the optional plugin trim_whitespace which reduces the size | |
145 | of the delivered html output by reducing redundant whitespace. | |
146 | ||
147 | See :ref:`core-plugin-section` for plugin documentation | |
148 | ||
1f01df1d CAW |
149 | * **A new API!** |
150 | ||
151 | It isn't well documented yet but we do have an API. There is an | |
152 | `android application in progress <https://gitorious.org/mediagoblin/mediagoblin-android>`_ | |
153 | which makes use of it, and there are some demo applications between | |
154 | `automgtic <https://github.com/jwandborg/automgtic>`_, an | |
155 | automatic media uploader for your desktop | |
156 | and `OMGMG <https://github.com/jwandborg/omgmg>`_, an example of | |
157 | a web application hooking up to the API. | |
158 | ||
159 | This is a plugin, so you have to enable it in your mediagoblin | |
160 | config file by adding a section under [plugins] like:: | |
161 | ||
162 | [plugins] | |
163 | [[mediagoblin.plugins.api]] | |
164 | ||
165 | Note that the API works but is not nailed down... the way it is | |
166 | called may change in future releases. | |
167 | ||
168 | * **OAuth login support** | |
169 | ||
170 | For applications that use OAuth to connect to the API. | |
171 | ||
172 | This is a plugin, so you have to enable it in your mediagoblin | |
173 | config file by adding a section under [plugins] like:: | |
174 | ||
175 | [plugins] | |
176 | [[mediagoblin.plugins.oauth]] | |
177 | ||
178 | * **Collections** | |
179 | ||
180 | We now have user-curated collections support. These are arbitrary | |
181 | galleries that are customizable by users. You can add media to | |
182 | these by clicking on the paperclip icon when logged in and looking | |
183 | at a media entry. | |
184 | ||
185 | * **OpenStreetMap licensing display improvements** | |
186 | ||
187 | More accurate display of OSM licensing, and less disruptive: you | |
188 | click to "expand" the display of said licensing. | |
189 | ||
190 | Geolocation is also now on by default. | |
191 | ||
192 | * **Miscelaneous visual improvements** | |
193 | ||
194 | We've made a number of small visual improvements including newer and | |
195 | nicer looking thumbnails and improved checkbox placement. | |
196 | ||
197 | ||
5be6425c | 198 | |
3a438f5e WKG |
199 | 0.3.1 |
200 | ===== | |
201 | ||
9e579cde WKG |
202 | **Do this to upgrade** |
203 | ||
204 | 1. Make sure to run ``bin/gmg dbuptdate`` after upgrading. | |
205 | ||
206 | 2. If you set up your server config with an older version of | |
207 | mediagoblin and the mediagoblin docs, it's possible you don't | |
208 | have the "theme static files" alias, so double check to make | |
209 | sure that section is there if you are having problems. | |
210 | ||
211 | ||
212 | ||
213 | **New features** | |
214 | ||
215 | * **theming support** | |
216 | ||
217 | MediaGoblin now also includes theming support, which you can | |
218 | read about in the section :ref:`theming-chapter`. | |
219 | ||
220 | * **flatpages** | |
221 | ||
222 | MediaGoblin has a flatpages plugin allowing you to add pages that | |
223 | are aren't media-related like "About this site...", "Terms of | |
224 | service...", etc. | |
225 | ||
226 | See :ref:`core-plugin-section` for plugin documentation | |
3a438f5e WKG |
227 | |
228 | ||
6e930791 CAW |
229 | 0.3.0 |
230 | ===== | |
5be6425c E |
231 | |
232 | This release has one important change. You need to act when | |
233 | upgrading from a previous version! | |
234 | ||
235 | This release changes the database system from MongoDB to | |
236 | SQL(alchemy). If you want to setup a fresh instance, just | |
237 | follow the instructions in the deployment chapter. If on | |
238 | the other hand you want to continue to use one instance, | |
239 | read on. | |
240 | ||
dce37922 | 241 | To convert your data from MongoDB to SQL(alchemy), you need |
5be6425c E |
242 | to follow these steps: |
243 | ||
244 | 1. Make sure your MongoDB is still running and has your | |
245 | data, it's needed for the conversion. | |
246 | ||
abe74178 WKG |
247 | 2. Configure the ``sql_engine`` URI in the config to represent |
248 | your target database (see: :ref:`deploying-chapter`) | |
5be6425c E |
249 | |
250 | 3. You need an empty database. | |
251 | ||
252 | 4. Then run the following command:: | |
253 | ||
abe74178 | 254 | bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql |
5be6425c E |
255 | |
256 | 5. Start your server and investigate. | |
257 | ||
258 | 6. That's it. |