Commit | Line | Data |
---|---|---|
473a4431 CAW |
1 | .. MediaGoblin Documentation |
2 | ||
fd5c35e5 | 3 | Written in 2011, 2012, 2013 by MediaGoblin contributors |
473a4431 CAW |
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 | ||
abe74178 WKG |
14 | .. _deploying-chapter: |
15 | ||
4e893b6e | 16 | ===================== |
17 | Deploying MediaGoblin | |
18 | ===================== | |
00fdc7bd | 19 | |
e260065a CAW |
20 | GNU MediaGoblin is fairly new and so at the time of writing, there |
21 | aren't easy package-manager-friendly methods to install MediaGoblin. | |
22 | However, doing a basic install isn't too complex in and of itself. | |
56d507b6 | 23 | |
e260065a CAW |
24 | There's an almost infinite way to deploy things... for now, we'll keep |
25 | it simple with some assumptions and use a setup that combines | |
26 | mediagoblin + virtualenv + fastcgi + nginx on a .deb or .rpm based | |
27 | GNU/Linux distro. | |
28 | ||
076bf0cf WKG |
29 | .. note:: |
30 | ||
31 | These tools are for site administrators wanting to deploy a fresh | |
32 | install. If instead you want to join in as a contributor, see our | |
33 | `Hacking HOWTO <http://wiki.mediagoblin.org/HackingHowto>`_ instead. | |
e260065a | 34 | |
4d8a3cd8 CAW |
35 | There are also many ways to install servers... for the sake of |
36 | simplicity, our instructions below describe installing with nginx. | |
37 | For more recipes, including Apache, see | |
38 | `our wiki <http://wiki.mediagoblin.org/Deployment>`_. | |
39 | ||
4e893b6e | 40 | Prepare System |
41 | -------------- | |
e260065a | 42 | |
4e893b6e | 43 | Dependencies |
44 | ~~~~~~~~~~~~ | |
e260065a | 45 | |
4e893b6e | 46 | MediaGoblin has the following core dependencies: |
e260065a | 47 | |
2acf47d8 | 48 | - Python 2.7 |
4e893b6e | 49 | - `python-lxml <http://lxml.de/>`_ |
50 | - `git <http://git-scm.com/>`_ | |
775ec9e8 | 51 | - `SQLite <http://www.sqlite.org/>`_/`PostgreSQL <http://www.postgresql.org/>`_ |
4e893b6e | 52 | - `Python Imaging Library <http://www.pythonware.com/products/pil/>`_ (PIL) |
53 | - `virtualenv <http://www.virtualenv.org/>`_ | |
4ec1af11 | 54 | - `nodejs <https://nodejs.org>`_ |
e260065a | 55 | |
4e893b6e | 56 | On a DEB-based system (e.g Debian, gNewSense, Trisquel, Ubuntu, and |
7798f911 | 57 | derivatives) issue the following command:: |
e260065a | 58 | |
c3075e91 | 59 | # apt-get install git-core python python-dev python-lxml \ |
4ec1af11 | 60 | python-imaging python-virtualenv npm automake |
e260065a | 61 | |
4e893b6e | 62 | On a RPM-based system (e.g. Fedora, RedHat, and derivatives) issue the |
7798f911 | 63 | following command:: |
4e893b6e | 64 | |
c3075e91 | 65 | # yum install python-paste-deploy python-paste-script \ |
076bf0cf | 66 | git-core python python-devel python-lxml python-imaging \ |
4ec1af11 | 67 | python-virtualenv npm automake |
e260065a | 68 | |
775ec9e8 JW |
69 | Configure PostgreSQL |
70 | ~~~~~~~~~~~~~~~~~~~~ | |
71 | ||
72 | .. note:: | |
73 | ||
7798f911 WKG |
74 | MediaGoblin currently supports PostgreSQL and SQLite. The default is a |
75 | local SQLite database. This will "just work" for small deployments. | |
775ec9e8 | 76 | |
7798f911 WKG |
77 | For medium to large deployments we recommend PostgreSQL. |
78 | ||
79 | If you don't want/need postgres, skip this section. | |
80 | ||
fd5c35e5 | 81 | These are the packages needed for Debian Wheezy (stable):: |
775ec9e8 | 82 | |
c3075e91 JC |
83 | # apt-get install postgresql postgresql-client python-psycopg2 |
84 | ||
85 | These are the packages needed for an RPM-based system:: | |
86 | ||
87 | # yum install postgresql postgresql-server python-psycopg2 | |
88 | ||
89 | An RPM-based system also requires that you initialize the PostgresSQL database | |
90 | with this command. The following command is not needed on a Debian-based | |
91 | platform, however:: | |
92 | ||
93 | # /usr/bin/postgresql-setup initdb | |
775ec9e8 JW |
94 | |
95 | The installation process will create a new *system* user named ``postgres``, | |
c3075e91 | 96 | which will have privilegies sufficient to manage the database. We will create a |
775ec9e8 JW |
97 | new database user with restricted privilegies and a new database owned by our |
98 | restricted database user for our MediaGoblin instance. | |
99 | ||
100 | In this example, the database user will be ``mediagoblin`` and the database | |
101 | name will be ``mediagoblin`` too. | |
102 | ||
c3075e91 JC |
103 | We'll add these entities by first switching to the *postgres* account:: |
104 | ||
f6d1b29f | 105 | # su - postgres |
775ec9e8 | 106 | |
c3075e91 JC |
107 | This will change your prompt to a shell prompt, such as *-bash-4.2$*. Enter |
108 | the following *createuser* and *createdb* commands at that prompt. We'll | |
109 | create the *mediagoblin* database user first:: | |
775ec9e8 | 110 | |
c3075e91 | 111 | $ createuser -A -D mediagoblin |
775ec9e8 | 112 | |
c3075e91 JC |
113 | Then we'll create the database where all of our MediaGoblin data will be stored:: |
114 | ||
115 | $ createdb -E UNICODE -O mediagoblin mediagoblin | |
775ec9e8 JW |
116 | |
117 | where the first ``mediagoblin`` is the database owner and the second | |
118 | ``mediagoblin`` is the database name. | |
119 | ||
c3075e91 JC |
120 | Type ``exit`` to return to the *root* user prompt. From here we just need to |
121 | set the Postgres database to start on boot, and also start it up for this | |
122 | particular session. If you're on a platform that does not use *systemd*, you | |
123 | can enter:: | |
124 | ||
125 | # chkconfig postgresql on && service postgresql start | |
126 | ||
127 | Whereas users of *systemd*-based systems will need to enter:: | |
128 | ||
129 | # systemctl enable postgresql && systemctl start postgresql | |
130 | ||
775ec9e8 JW |
131 | .. caution:: Where is the password? |
132 | ||
133 | These steps enable you to authenticate to the database in a password-less | |
134 | manner via local UNIX authentication provided you run the MediaGoblin | |
135 | application as a user with the same name as the user you created in | |
136 | PostgreSQL. | |
137 | ||
138 | More on this in :ref:`Drop Privileges for MediaGoblin <drop-privileges-for-mediagoblin>`. | |
139 | ||
140 | ||
775ec9e8 JW |
141 | .. _drop-privileges-for-mediagoblin: |
142 | ||
4e893b6e | 143 | Drop Privileges for MediaGoblin |
144 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
17c71230 | 145 | |
fd5c35e5 | 146 | MediaGoblin does not require special permissions or elevated |
1b4a9f26 CAW |
147 | access to run. As such, the preferred way to run MediaGoblin is to |
148 | create a dedicated, unprivileged system user for the sole purpose of running | |
fd5c35e5 JC |
149 | MediaGoblin. Running MediaGoblin processes under an unpriviledged system user |
150 | helps to keep it more secure. | |
151 | ||
152 | The following command (entered as root or with sudo) will create a | |
153 | system account with a username of ``mediagoblin``. You may choose a different | |
154 | username if you wish.:: | |
155 | ||
9a1ba0e8 | 156 | # useradd --system --user-group mediagoblin |
fd5c35e5 JC |
157 | |
158 | No password will be assigned to this account, and you will not be able | |
9a1ba0e8 | 159 | to log in as this user. To switch to this account, enter:: |
fd5c35e5 | 160 | |
f055b475 | 161 | su mediagoblin -s /bin/bash # (if you have to use root permissions) |
fd5c35e5 JC |
162 | |
163 | You may get a warning similar to this when entering these commands:: | |
164 | ||
9b604868 | 165 | warning: cannot change directory to /home/mediagoblin: No such file or directory |
fd5c35e5 JC |
166 | |
167 | You can disregard this warning. To return to your regular user account after | |
168 | using the system account, just enter ``exit``. | |
169 | ||
fd5c35e5 JC |
170 | .. _create-mediagoblin-directory: |
171 | ||
172 | Create a MediaGoblin Directory | |
173 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
17c71230 | 174 | |
4e893b6e | 175 | You should create a working directory for MediaGoblin. This document |
076bf0cf | 176 | assumes your local git repository will be located at |
fd5c35e5 JC |
177 | ``/srv/mediagoblin.example.org/mediagoblin/``. |
178 | Substitute your prefered local deployment path as needed. | |
179 | ||
180 | Setting up the working directory requires that we first create the directory | |
181 | with elevated priviledges, and then assign ownership of the directory | |
182 | to the unpriviledged system account. | |
17c71230 | 183 | |
fd5c35e5 JC |
184 | To do this, enter either of the following commands, changing the defaults |
185 | to suit your particular requirements:: | |
17c71230 | 186 | |
c3075e91 | 187 | # mkdir -p /srv/mediagoblin.example.org && sudo chown -hR mediagoblin: /srv/mediagoblin.example.org |
fd5c35e5 | 188 | |
c3075e91 | 189 | .. note:: |
fd5c35e5 | 190 | |
c3075e91 JC |
191 | Unless otherwise noted, the remainder of this document assumes that all |
192 | operations are performed using this unpriviledged account. | |
17c71230 | 193 | |
4e893b6e | 194 | |
e260065a | 195 | Install MediaGoblin and Virtualenv |
4e893b6e | 196 | ---------------------------------- |
e260065a | 197 | |
fd5c35e5 JC |
198 | We will now clone the MediaGoblin source code repository and setup and |
199 | configure the necessary services. Modify these commands to | |
9a1ba0e8 JC |
200 | suit your own environment. |
201 | ||
202 | .. note:: | |
203 | ||
204 | As a reminder, you should enter these commands using your unpriviledged | |
205 | *mediagoblin* system account. | |
17c71230 | 206 | |
fd5c35e5 JC |
207 | Change to the MediaGoblin directory that you just created:: |
208 | ||
9a1ba0e8 | 209 | $ cd /srv/mediagoblin.example.org |
17c71230 | 210 | |
d3b1fd2e | 211 | Clone the MediaGoblin repository and set up the git submodules:: |
e260065a | 212 | |
9a1ba0e8 JC |
213 | $ git clone https://gitorious.org/mediagoblin/mediagoblin.git -b stable |
214 | $ cd mediagoblin | |
215 | $ git submodule init && git submodule update | |
e260065a | 216 | |
e260065a | 217 | |
41dbb27a | 218 | Set up the hacking environment:: |
3b8251f3 | 219 | |
9a1ba0e8 | 220 | $ ./bootstrap.sh && ./configure && make |
f0e137ab | 221 | |
4e893b6e | 222 | The above provides an in-package install of ``virtualenv``. While this |
223 | is counter to the conventional ``virtualenv`` configuration, it is | |
224 | more reliable and considerably easier to configure and illustrate. If | |
225 | you're familiar with Python packaging you may consider deploying with | |
c356dc16 | 226 | your preferred method. |
e260065a | 227 | |
076bf0cf WKG |
228 | Assuming you are going to deploy with FastCGI, you should also install |
229 | flup:: | |
99192f24 | 230 | |
9a1ba0e8 | 231 | $ ./bin/easy_install flup |
71ef2007 | 232 | |
4e893b6e | 233 | This concludes the initial configuration of the development |
8d9aa03f | 234 | environment. In the future, when you update your |
076bf0cf | 235 | codebase, you should also run:: |
e260065a | 236 | |
9a1ba0e8 JC |
237 | $ git submodule update && ./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate |
238 | ||
239 | .. note:: | |
e260065a | 240 | |
9a1ba0e8 JC |
241 | Note: If you are running an active site, depending on your server |
242 | configuration, you may need to stop it first or the dbupdate command | |
243 | may hang (and it's certainly a good idea to restart it after the | |
244 | update) | |
9d5cd0b9 CAW |
245 | |
246 | ||
4e893b6e | 247 | Deploy MediaGoblin Services |
248 | --------------------------- | |
e260065a | 249 | |
a7d2a892 ST |
250 | Edit site configuration |
251 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
252 | ||
041d2fd7 CAW |
253 | A few basic properties must be set before MediaGoblin will work. First |
254 | make a copy of ``mediagoblin.ini`` for editing so the original config | |
255 | file isn't lost:: | |
a7d2a892 ST |
256 | |
257 | cp mediagoblin.ini mediagoblin_local.ini | |
a7d2a892 | 258 | |
041d2fd7 CAW |
259 | Then: |
260 | - Set ``email_sender_address`` to the address you wish to be used as | |
261 | the sender for system-generated emails | |
262 | - Edit ``direct_remote_path``, ``base_dir``, and ``base_url`` if | |
263 | your mediagoblin directory is not the root directory of your | |
264 | vhost. | |
a7d2a892 ST |
265 | |
266 | ||
775ec9e8 JW |
267 | Configure MediaGoblin to use the PostgreSQL database |
268 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
269 | ||
7798f911 WKG |
270 | If you are using postgres, edit the ``[mediagoblin]`` section in your |
271 | ``mediagoblin_local.ini`` and put in:: | |
775ec9e8 JW |
272 | |
273 | sql_engine = postgresql:///mediagoblin | |
274 | ||
275 | if you are running the MediaGoblin application as the same 'user' as the | |
276 | database owner. | |
277 | ||
7798f911 | 278 | |
775ec9e8 JW |
279 | Update database data structures |
280 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
281 | ||
7798f911 | 282 | Before you start using the database, you need to run:: |
775ec9e8 JW |
283 | |
284 | ./bin/gmg dbupdate | |
285 | ||
286 | to populate the database with the MediaGoblin data structures. | |
287 | ||
288 | ||
4e893b6e | 289 | Test the Server |
290 | ~~~~~~~~~~~~~~~ | |
e260065a | 291 | |
4e893b6e | 292 | At this point MediaGoblin should be properly installed. You can |
076bf0cf | 293 | test the deployment with the following command:: |
e260065a | 294 | |
076bf0cf | 295 | ./lazyserver.sh --server-name=broadcast |
e260065a | 296 | |
4e893b6e | 297 | You should be able to connect to the machine on port 6543 in your |
298 | browser to confirm that the service is operable. | |
e260065a | 299 | |
cd1abb11 CAW |
300 | .. _webserver-config: |
301 | ||
56d507b6 | 302 | |
a7d2a892 ST |
303 | FastCGI and nginx |
304 | ~~~~~~~~~~~~~~~~~ | |
305 | ||
306 | This configuration example will use nginx, however, you may | |
4e893b6e | 307 | use any webserver of your choice as long as it supports the FastCGI |
308 | protocol. If you do not already have a web server, consider nginx, as | |
309 | the configuration files may be more clear than the | |
310 | alternatives. | |
311 | ||
312 | Create a configuration file at | |
313 | ``/srv/mediagoblin.example.org/nginx.conf`` and create a symbolic link | |
314 | into a directory that will be included in your ``nginx`` configuration | |
315 | (e.g. "``/etc/nginx/sites-enabled`` or ``/etc/nginx/conf.d``) with | |
076bf0cf | 316 | one of the following commands (as the root user):: |
4e893b6e | 317 | |
076bf0cf WKG |
318 | ln -s /srv/mediagoblin.example.org/nginx.conf /etc/nginx/conf.d/ |
319 | ln -s /srv/mediagoblin.example.org/nginx.conf /etc/nginx/sites-enabled/ | |
4e893b6e | 320 | |
321 | Modify these commands and locations depending on your preferences and | |
322 | the existing configuration of your nginx instance. The contents of | |
076bf0cf WKG |
323 | this ``nginx.conf`` file should be modeled on the following:: |
324 | ||
325 | server { | |
326 | ################################################# | |
327 | # Stock useful config options, but ignore them :) | |
328 | ################################################# | |
329 | include /etc/nginx/mime.types; | |
330 | ||
331 | autoindex off; | |
332 | default_type application/octet-stream; | |
333 | sendfile on; | |
334 | ||
335 | # Gzip | |
336 | gzip on; | |
337 | gzip_min_length 1024; | |
338 | gzip_buffers 4 32k; | |
339 | gzip_types text/plain text/html application/x-javascript text/javascript text/xml text/css; | |
340 | ||
341 | ##################################### | |
342 | # Mounting MediaGoblin stuff | |
343 | # This is the section you should read | |
344 | ##################################### | |
345 | ||
346 | # Change this to update the upload size limit for your users | |
347 | client_max_body_size 8m; | |
348 | ||
a49c741f CAW |
349 | # prevent attacks (someone uploading a .txt file that the browser |
350 | # interprets as an HTML file, etc.) | |
351 | add_header X-Content-Type-Options nosniff; | |
37b48053 | 352 | |
076bf0cf WKG |
353 | server_name mediagoblin.example.org www.mediagoblin.example.org; |
354 | access_log /var/log/nginx/mediagoblin.example.access.log; | |
355 | error_log /var/log/nginx/mediagoblin.example.error.log; | |
356 | ||
357 | # MediaGoblin's stock static files: CSS, JS, etc. | |
358 | location /mgoblin_static/ { | |
359 | alias /srv/mediagoblin.example.org/mediagoblin/mediagoblin/static/; | |
360 | } | |
361 | ||
362 | # Instance specific media: | |
363 | location /mgoblin_media/ { | |
364 | alias /srv/mediagoblin.example.org/mediagoblin/user_dev/media/public/; | |
365 | } | |
366 | ||
8d051cc0 CAW |
367 | # Theme static files (usually symlinked in) |
368 | location /theme_static/ { | |
369 | alias /srv/mediagoblin.example.org/mediagoblin/user_dev/theme_static/; | |
370 | } | |
371 | ||
24ede044 CAW |
372 | # Plugin static files (usually symlinked in) |
373 | location /plugin_static/ { | |
374 | alias /srv/mediagoblin.example.org/mediagoblin/user_dev/plugin_static/; | |
375 | } | |
376 | ||
076bf0cf WKG |
377 | # Mounting MediaGoblin itself via FastCGI. |
378 | location / { | |
379 | fastcgi_pass 127.0.0.1:26543; | |
380 | include /etc/nginx/fastcgi_params; | |
381 | ||
382 | # our understanding vs nginx's handling of script_name vs | |
383 | # path_info don't match :) | |
384 | fastcgi_param PATH_INFO $fastcgi_script_name; | |
385 | fastcgi_param SCRIPT_NAME ""; | |
4e893b6e | 386 | } |
076bf0cf | 387 | } |
4e893b6e | 388 | |
f44bd7dc CAW |
389 | The first four ``location`` directives instruct Nginx to serve the |
390 | static and uploaded files directly rather than through the MediaGoblin | |
391 | process. This approach is faster and requires less memory. | |
392 | ||
393 | .. note:: | |
394 | ||
395 | The user who owns the Nginx process, normally ``www-data``, | |
396 | requires execute permission on the directories ``static``, | |
397 | ``public``, ``theme_static`` and ``plugin_static`` plus all their | |
398 | parent directories. This user also requires read permission on all | |
399 | the files within these directories. This is normally the default. | |
400 | ||
4e893b6e | 401 | Now, nginx instance is configured to serve the MediaGoblin |
402 | application. Perform a quick test to ensure that this configuration | |
403 | works. Restart nginx so it picks up your changes, with a command that | |
076bf0cf | 404 | resembles one of the following (as the root user):: |
4e893b6e | 405 | |
076bf0cf WKG |
406 | sudo /etc/init.d/nginx restart |
407 | sudo /etc/rc.d/nginx restart | |
4e893b6e | 408 | |
409 | Now start MediaGoblin. Use the following command sequence as an | |
076bf0cf | 410 | example:: |
4e893b6e | 411 | |
076bf0cf WKG |
412 | cd /srv/mediagoblin.example.org/mediagoblin/ |
413 | ./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543 | |
4e893b6e | 414 | |
415 | Visit the site you've set up in your browser by visiting | |
518c5eb3 | 416 | <http://mediagoblin.example.org>. You should see MediaGoblin! |
4e893b6e | 417 | |
4e893b6e | 418 | .. note:: |
419 | ||
a085dda5 | 420 | The configuration described above is sufficient for development and |
421 | smaller deployments. However, for larger production deployments | |
422 | with larger processing requirements, see the | |
423 | ":doc:`production-deployments`" documentation. | |
a7d2a892 ST |
424 | |
425 | ||
426 | Apache | |
427 | ~~~~~~ | |
428 | ||
041d2fd7 CAW |
429 | Instructions and scripts for running MediaGoblin on an Apache server |
430 | can be found on the `MediaGoblin wiki <http://wiki.mediagoblin.org/Deployment>`_. | |
b835e153 E |
431 | |
432 | ||
433 | Security Considerations | |
434 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
435 | ||
436 | .. warning:: | |
437 | ||
438 | The directory ``user_dev/crypto/`` contains some very | |
439 | sensitive files. | |
440 | Especially the ``itsdangeroussecret.bin`` is very important | |
441 | for session security. Make sure not to leak its contents anywhere. | |
442 | If the contents gets leaked nevertheless, delete your file | |
443 | and restart the server, so that it creates a new secret key. | |
fd5c35e5 JC |
444 | All previous sessions will be invalidated. |
445 | ||
f44bd7dc CAW |
446 | .. |
447 | Local variables: | |
448 | fill-column: 70 | |
449 | End: |