GNU MediaGoblin Wiki - User contributions [en]

GSOC 2013

2013-04-04T10:17:41Z

Spaetz: /* Document / presentation system */

We are participating in [http://www.google-melange.com/gsoc/homepage/google/gsoc2013 GSOC 2013] (if we're accepted, that is!)

To both students and mentors, please read up on the [http://www.google-melange.com/document/show/gsoc_program/google/gsoc2013/help_page GSOC 2013 help page]!

= How do I apply as a student? =

Well, we need to be accepted as a mentoring org first :)

But then:
* Submit your application (details coming soon)
* [http://mediagoblin.org/pages/join.html Join us] on IRC and on our mailing lists.
* Set up a development environment via our [[HackingHowto]]

It's important that you communicate... most MediaGoblin communication happens on IRC, so you should [http://webchat.freenode.net/?channels=mediagoblin join us there] and discuss (#mediagoblin on irc.freenode.net)!

= Possible projects =

Here are a list of projects that students may wish to apply for for GSOC 2013:

== Blogging system ==

We've had an increasing number of people ask if MediaGoblin would be a useful blogging system. The answer is that at present, it isn't: even though we support an ascii art media type, media types aren't really the right way to handle blogging since they don't really fit with the "gallery" style of editing things in MediaGoblin.

But people are interested in something that's more along the lines of Tumblr: a blogging platform with good media embedding integration. In many ways, MediaGoblin is perfect for this!

Some thoughts:

* Blogs might go at /u/foo-user/b/ and individual blogposts at /u/foo-user/b/blogpost-slug/
* Blogging should be a plugin
* HTML with something like TinyMCE integration would be good. HTML would need to be cleaned on the backend.
* Maybe other types would be allowed (markdown, restructured text) though I'm not sure how much more complex that makes cleaning HTML output.
* What about commenting? Would we need a seaparate comments table?

Possible Mentor: spaetz

== Document / presentation system ==

There's some work toward a [http://issues.mediagoblin.org/ticket/391 document type] in MediaGoblin, but to get a *really nice* document type, it might take some work.

* Conversion from various documents to PDF via libreoffice on the backend
* On-page reading with pdf.js
* Preservation of original file, with ability to download
* Other things???

'''Possible mentors:''' Spaetz, Nathan Yergler, Aeva NTSC

== Pluggable user authentication & implementations ==

We'd like a pluggable user authentication module. Some people want to use things like LDAP. Some people would also like BrowserID integration.

With our new work toward pluginification it would be good to see the structure for user authentication to be interface'ified. It would also be good to have implementation for several types of logins such as BrowserID, LDAP, and central authentication system stuff.

'''Possible mentors:''' Nathan Yergler, Joar Wandborg

== Administrative interface / moderation tools ==

At present there isn't much as in terms of tooling to deal with things as an administrator. Several things would be greatly of help to admins at present:

* Views to search for users and take actions upon them
* Tools to deal with handling problematic content/users
* More generalized panel for looking at things being processed
* ???

'''Possible mentors:''' --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:02, 1 April 2013 (EDT), Joar Wandborg

== Processing panel improvements ==

While media is being uploaded, there's not very good and clear indications of this, though we have some basics.

* Show the number of entries that are currently in processing in the dropdown user panel at the top of mediagoblin instances
* In media entries that are currently in progress, give clearer information about amount of work left? (Note, showing percentages might be hard)
* Nicer looking demonstrations of what failed.

Note: this one might require a lot of graphic design and discussion; anyone interested in it would have to work closely with people on IRC before submitting a real proposal.

'''Possible mentors:''' --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:03, 1 April 2013 (EDT), Joar Wandborg

== Pluginifying media types ==

Media types currently have their own way of being configured separately. It would be good to be able to make them into bona-fide plugins (if anything with some special case metadata). This will also allow media types to define things like special-case views, etc.

Possible mentors: --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:02, 1 April 2013 (EDT), Joar Wandborg

'''Possible mentors:''' Joar Wandborg

== User upload account limits ==

It would be great to have the ability to set limits on the amount of stuff people can upload. This would involve both hooks to track the space of media as it's saved (maybe this should be fairly core?) as well as the ability to refuse an upload because a limit has been already hit. Tools to change limits would also be good, especially via an administrative interface and ./bin/gmg

--[[User:Joar|Joar]] ([[User talk:Joar|talk]]) 07:41, 30 March 2013 (EDT) <code>mediagoblin.storage.StorageInterface</code> should probably implement a <code>get_size</code> method or similar.

'''Possible mentors:''' Joar Wandborg

== Search interface ==

We don't have any sort of search for media whatsoever at present. Obviously people want this!

There's been some discussion of a search interface that would be federated, but for the scope of this, we don't need to worry about that. It would be enough to investigate a search engine that would allow for searching across the subjects/titles/descriptions of media.

'''Possible mentors:''' Nathan Yergler, Aeva NTSC

== Media type reprocessing framework ==

This one is tricky! Basically, allowing media to go back into processing... ie, resizing an image to a new size, re-transcoding video, etc.

'''Possible mentors:''' Joar Wandborg

GSOC 2013

2013-04-04T10:17:17Z

Spaetz: /* Blogging system */

We are participating in [http://www.google-melange.com/gsoc/homepage/google/gsoc2013 GSOC 2013] (if we're accepted, that is!)

To both students and mentors, please read up on the [http://www.google-melange.com/document/show/gsoc_program/google/gsoc2013/help_page GSOC 2013 help page]!

= How do I apply as a student? =

Well, we need to be accepted as a mentoring org first :)

But then:
* Submit your application (details coming soon)
* [http://mediagoblin.org/pages/join.html Join us] on IRC and on our mailing lists.
* Set up a development environment via our [[HackingHowto]]

It's important that you communicate... most MediaGoblin communication happens on IRC, so you should [http://webchat.freenode.net/?channels=mediagoblin join us there] and discuss (#mediagoblin on irc.freenode.net)!

= Possible projects =

Here are a list of projects that students may wish to apply for for GSOC 2013:

== Blogging system ==

We've had an increasing number of people ask if MediaGoblin would be a useful blogging system. The answer is that at present, it isn't: even though we support an ascii art media type, media types aren't really the right way to handle blogging since they don't really fit with the "gallery" style of editing things in MediaGoblin.

But people are interested in something that's more along the lines of Tumblr: a blogging platform with good media embedding integration. In many ways, MediaGoblin is perfect for this!

Some thoughts:

* Blogs might go at /u/foo-user/b/ and individual blogposts at /u/foo-user/b/blogpost-slug/
* Blogging should be a plugin
* HTML with something like TinyMCE integration would be good. HTML would need to be cleaned on the backend.
* Maybe other types would be allowed (markdown, restructured text) though I'm not sure how much more complex that makes cleaning HTML output.
* What about commenting? Would we need a seaparate comments table?

Possible Mentor: spaetz

== Document / presentation system ==

There's some work toward a [http://issues.mediagoblin.org/ticket/391 document type] in MediaGoblin, but to get a *really nice* document type, it might take some work.

* Conversion from various documents to PDF via libreoffice on the backend
* On-page reading with pdf.js
* Preservation of original file, with ability to download
* Other things???

'''Possible mentors:''' Nathan Yergler, Aeva NTSC

== Pluggable user authentication & implementations ==

We'd like a pluggable user authentication module. Some people want to use things like LDAP. Some people would also like BrowserID integration.

With our new work toward pluginification it would be good to see the structure for user authentication to be interface'ified. It would also be good to have implementation for several types of logins such as BrowserID, LDAP, and central authentication system stuff.

'''Possible mentors:''' Nathan Yergler, Joar Wandborg

== Administrative interface / moderation tools ==

At present there isn't much as in terms of tooling to deal with things as an administrator. Several things would be greatly of help to admins at present:

* Views to search for users and take actions upon them
* Tools to deal with handling problematic content/users
* More generalized panel for looking at things being processed
* ???

'''Possible mentors:''' --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:02, 1 April 2013 (EDT), Joar Wandborg

== Processing panel improvements ==

While media is being uploaded, there's not very good and clear indications of this, though we have some basics.

* Show the number of entries that are currently in processing in the dropdown user panel at the top of mediagoblin instances
* In media entries that are currently in progress, give clearer information about amount of work left? (Note, showing percentages might be hard)
* Nicer looking demonstrations of what failed.

Note: this one might require a lot of graphic design and discussion; anyone interested in it would have to work closely with people on IRC before submitting a real proposal.

'''Possible mentors:''' --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:03, 1 April 2013 (EDT), Joar Wandborg

== Pluginifying media types ==

Media types currently have their own way of being configured separately. It would be good to be able to make them into bona-fide plugins (if anything with some special case metadata). This will also allow media types to define things like special-case views, etc.

Possible mentors: --[[User:Copiesofcopies|Copiesofcopies]] ([[User talk:Copiesofcopies|talk]]) 15:02, 1 April 2013 (EDT), Joar Wandborg

'''Possible mentors:''' Joar Wandborg

== User upload account limits ==

It would be great to have the ability to set limits on the amount of stuff people can upload. This would involve both hooks to track the space of media as it's saved (maybe this should be fairly core?) as well as the ability to refuse an upload because a limit has been already hit. Tools to change limits would also be good, especially via an administrative interface and ./bin/gmg

--[[User:Joar|Joar]] ([[User talk:Joar|talk]]) 07:41, 30 March 2013 (EDT) <code>mediagoblin.storage.StorageInterface</code> should probably implement a <code>get_size</code> method or similar.

'''Possible mentors:''' Joar Wandborg

== Search interface ==

We don't have any sort of search for media whatsoever at present. Obviously people want this!

There's been some discussion of a search interface that would be federated, but for the scope of this, we don't need to worry about that. It would be enough to investigate a search engine that would allow for searching across the subjects/titles/descriptions of media.

'''Possible mentors:''' Nathan Yergler, Aeva NTSC

== Media type reprocessing framework ==

This one is tricky! Basically, allowing media to go back into processing... ie, resizing an image to a new size, re-transcoding video, etc.

'''Possible mentors:''' Joar Wandborg

Translations

2012-12-05T08:27:13Z

Spaetz: /* For translators */

= For translators =

It is very easy to add or complete the translation of MediaGoblin! We use the web interface provided by Transifex.net to do the translations. You can see the current status of the translations per language [https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/ here].

To start translating, just:

# click on your language in [https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/ that list] then
# click on "Translate now".

By default, Transifex only shows you strings that currently have no translation. There is a checkbox to enable the display of already translated strings, in case you want to improve any of them.
There are no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation). If you are a regular contributor to the translations, you might want to add some notes to the [[#Notes for some language teams|per-language section on this page]] to coordinate consistent translations.

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "Du" für die Anrede benutzt. "Du" und "Deine" werden groß geschrieben. Benutze die folgenden Begriffe um konsistent zu bleiben:

Benutzerkonto/Nutzerkonto, E-Mail, E-Mail-Adresse, Aktivierungsmail, Konto "aktivieren" (verify email), Album (collection), Kurztitel (slug)

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

==Fixing translations from transifex==

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.

Main Page

2012-12-05T08:19:27Z

Spaetz: /* Translate MediaGoblin */

= Want to Join the MediaGoblin Community? =

We’re really glad that you want to join the MediaGoblin community!

There are a variety of ways to help and support MediaGoblin and to join the team. If you want to code, great, if not, even better! MediaGoblin interested contributors in many different roles: users, system administrators, technical writers, testers, evangelists, UI/UX and graphics designers, cheerleaders, and dreamers.

This wiki covers a variety of ways that you can get involved with MediaGoblin as well as instructions on how to get started.

== Hang out with the MediaGoblin folk ==

MediaGoblin has a mailing list and an IRC channel where we hang out. See [http://mediagoblin.org/pages/join.html our join page] for links.

Please drop by and say “Hi!” And, if you’re looking for something to do, just ask---there’s always work to be done.

== Take Part in the Monthly Meetings ==

Each month is a [[Meeting]]. You can take part and help decide on the future of MediaGoblin. Or just be around and see what's happening live!

== File Bugs / Triage Bugs ==

Issue reports are critical for all projects. Identified bugs give developers a basis for beginning work, and providing an idea of what features and issues are most important to users and the overall usability of the software. If you identify errors, flaws, unexpected behaviors, or deficits that impede use, file a bug.

* [[File Bugs]] -- notes on filing new bugs/issues/feature requests
* [[Feature Ideas]] -- notes on possible features
* [[Triage Bugs]] -- notes on triaging
* [[BugTriageDay]] -- every other Thursday is bug triage day where anyone can help out triaging bugs

== Write Code / Fix Code ==

If you are a coder and you would like to write code, the repository is hosted on gitorious. Clone or fork the repository and start poking around. Become familiar with this manual for an overview of how the software works and is used. Consider the contributor wiki for more information about the project, our preferred methods, and guides for developing MediaGoblin. We even have tips on becoming a coder and we’re willing to help!

* [[HackingHowto|Hacking]] - notes on making and sending in code contributions
** [[BeginnersCorner|Beginner's Corner]] - resources for those who are new to Python or Git.
** ''Started from an older version of the Hacking Howto? We switched from buildout->virtualenv, so look at [[Moving from buildout to virtualenv]] for information on how to move over.''
* [[Git workflow]] - How to go about submitting patches via git.
* [[Templating]] - How our templating structure is set up
* [[Code overview]] - Overview of the structure of the codebase

== Send Encouragement / Spread the Word ==

Sometimes, a nice word, simple encouragement, and interest in the work we’re doing is enough to inspire a tizzy of productive work. Just a bit more interest and encouragement can even make the difference between a complete feature and limited functionality; between a completed milestone and lost momentum.

Similarly, MediaGoblin, and the movement for free network services, is always in need of encouragement. Use free network services, understand the principals behind the movement, be able to articulate the benefits of free network services and the problems with psudo-free applications that don’t respect the users’ freedom.

Write a blog post, post a status update, drop by the listserv or join #mediagoblin on freenode.net and let us know. See [http://mediagoblin.org/join/ our join page] for links.

== Write Documentation / Edit Documentation ==

* [[Documentation quick start]] - How to contribute to the documentation effort.
* [[ManualStandards]] - covers the standards for writing the user manual (forthcoming.)

== Test MediaGoblin ==

Do you have access to the web? Do you like sharing your opinions? If so, we need your help to test MediaGoblin! Testers play around with the current test instance, note what operating system and browser they use (notes on multiple set-ups are also helpful) and take some notes. That's it! It's a very important task that doesn't require any special knowledge and you're done in under an hour. Ready to help?

* [[User Experience]] - user experience testing. Includes link to an instance you can try!
* [[UnitTests|Unit Tests]] - all about the unit tests

== Translate MediaGoblin ==

If you know English and another language and feel comfortable translating elements of the interface or even the documentation, we’d love to have help translating the software and resources.
Translating MediaGoblin is very easy with a web interface, so there is no programming knowledge required at all.

* [[Translations]] - How to translate stuff or update the translations

== Become a User ==

Coming soon!

We’re building MediaGoblin for us and for you but really you’re one of us and I am you and we are we and MediaGoblin is the walrus.

We're planning to launch our own public instance of MediaGoblin in the near future--probably in the September/October 2011 time frame. When we do, sign up for an account, use the service and relish in the thought that this service comes with a heaping side of Freedom and you can salt and pepper it to your liking.

== Help Others ==

Have you spent time with MediaGoblin? If so, your experience and wisdom are invaluable and you’re the best person we can think of to help other users with their questions.

Hang out on the IRC channel and help answer new peoples' questions. See [http://mediagoblin.org/join/ our join page] for links.

== Run your own MediaGoblin Instance ==

Are there things about our instance you want to change? Are there things about other instances you wish were different? Want to test upcoming changes? Want to create patches to implement things you need? That’s great—you can run your own instance!

* [[Configure_MediaGoblin|Configuration]] - Learn about MediaGoblin configuration files and file options.
* [[Deployment]] - General deployment advice
* [[Scaling Down]] - Minimizing MediaGoblin's resource requirements
* [[Virtual Machine Hosting]] - Deploy your own publicly available MediaGoblin server using [http://aws.amazon.com/free/?utm_source=adwords&utm_medium=cpc&utm_campaign=CPC_Google_AWS_ec2&utm_content=TextV01_PP_V01_EC2&trk=CPC_Google_AWS_ec2 Amazon's free EC2 tier].

== Create a Theme ==

Coming soon!

MedaGoblin development is premised on the idea that the entire interface for the platform be completely theme-able. If you have a design or theming background, consider developing themes for MediaGoblin. New themes help test the theming system, provide attractive and appealing interfaces for prospective users. If you want to start a new theme but don’t know where to start, touch base with the development community on the list or in the IRC channel for more information.

= Technical project documentation =

* [[DesignDecisions]] - covers design decisions (FIXME - this needs to be split up)
* [[Storage]] - How MediaGoblin's internal storage system works.
* [[Processing]] - What happens after you submit your image/video/etc? Processing! More about that.
* [https://gitorious.org/mediagoblin/mediagoblin/blobs/master/extlib/README External Library Policy] - covers use of external libraries
* [[User:Cwebber/braindumps]] - Chris Webber's braindumps (you can help refactoring these into real sections of the site!)
* [[Multiple media support]] - Design plan for multiple media support

= Inner workings of the secret sanctum =

* [[IRCBot]] - covers our irc bot
* [[ReleaseProcess|Release Process]] - covers the release process
* [[Update the website]] - Learn how to update mediagoblin.org!

Translations

2012-12-05T08:15:35Z

Spaetz: /* German */

= For translators =

You can translate our tools at Transifex:

https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/

To translate, click on your language on the list, and then click on "Translate now". By default, Transifex only shows you strings that currently have no translation. There is a checkbox to enable display of the translated strings, in case you can fix any of them.

We are currently using no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation).

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "Du" für die Anrede benutzt. "Du" und "Deine" werden groß geschrieben. Benutze die folgenden Begriffe um konsistent zu bleiben:

Benutzerkonto/Nutzerkonto, E-Mail, E-Mail-Adresse, Aktivierungsmail, Konto "aktivieren" (verify email), Album (collection), Kurztitel (slug)

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

==Fixing translations from transifex==

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.

Translations

2012-12-05T08:13:45Z

Spaetz: /* German */

= For translators =

You can translate our tools at Transifex:

https://www.transifex.net/projects/p/mediagoblin/resource/mediagoblin/

To translate, click on your language on the list, and then click on "Translate now". By default, Transifex only shows you strings that currently have no translation. There is a checkbox to enable display of the translated strings, in case you can fix any of them.

We are currently using no translation teams, so you can just edit the strings (but try to be nice and consistent with the current translation).

Note: please don't translate the words "MediaGoblin" or "GNU" into your native language. Those words should be retained as-is for branding reasons. :)

== Notes for some language teams ==
=== German ===

Interessante Hinweise zur Übersetzung finden sich bei Gnome:
* http://live.gnome.org/de/UebersetzungsRichtlinien

In Abweichung von diesen Richtlinien wird momentan "Du" für die Anrede benutzt. "Du" und "Deine" werden groß geschrieben. Benutze die folgenden Begriffe um konsistent zu bleiben:

Benutzerkonto/Nutzerkonto, E-Mail, E-Mail Adresse, Aktivierungsmail, Konto "aktivieren" (verify email), Album (collection), Kurztitel (slug)

=== Spanish ===

Se está adoptando la siguiente convención para la traducción al español. Si crees que alguna traducción se puede mejorar, sugiérela en la página de discusión de este artículo.

{|
!Inglés
!Español
!Comentarios
|-
|you
|tú
|(segunda persona del singular, expresión informal)
|-
|media
|contenido
|-
|slug
|ficha
|}

==Fixing translations from transifex==

= For developers =
== Marking strings for translation ==
=== In Jinja2 ===

See: http://jinja.pocoo.org/docs/templates/#i18n

Mostly like Django template i18n support, if you have any experience with that.

=== In python code ===

Usually, like this:

<pre>
from mediagoblin.util import pass_to_ugettext as _

def some_func(something):
return _(u'This string would tooootally be translatable now.')
</pre>

Except, in form modules we don't actually want to translate things because for various reasons that doesn't work, so we do the translation call template-side. So write the module to use the fake ugettext passthrough (which doesn't do any translation but still wraps things in _() so that Babel will know to extract these strings):

<pre>
from mediagoblin.util import fake_ugettext_passthrough as _

class FunkyMonkeyForm(wtforms.Form):
funky = wtforms.TextAreaField(
_('Funkiness description'))
</pre>

== Extracting translations ==

If you run buildout it should create a script called 'pybabel'. Use it to extract translations like so:

<pre>
./bin/pybabel extract -F babel.ini -o mediagoblin/i18n/en/LC_MESSAGES/mediagoblin.po .
</pre>

== Compiling translations ==

<pre>
./bin/pybabel compile -D mediagoblin -d mediagoblin/i18n/
</pre>

== Pulling translations from Transifex ==

Unfortunately until the next release of transifex-client which has been patched to have proper entry points, you have to run transifex-client from a virtualenv or from site-packages. But assuming that's done, pulling translations is easy:

<pre>
tx pull -a
</pre>

== Pushing new translations to Transifex ==

<pre>
tx push -s
</pre>

= Troubleshooting =

Got an error on Transifex like:

"Translation must start with a newline (\n)"?

The problem here is when we have something like:

{% trans register_url=request.urlgen('mediagoblin.auth.register') %}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{% endtrans %}

instead of:

{% trans register_url=request.urlgen('mediagoblin.auth.register') -%}
<a class="header_submit_highlight" href="{{ register_url }}">Create a free account</a>
or
<a class="header_submit" href="http://wiki.mediagoblin.org/HackingHowto">Set up MediaGoblin on your own server</a>
{%- endtrans %}

The distinction might not be obvious... look for the %} versus -%} and {% versus {%- on the first and last lines. The thing about this is this tells Jinja2 to strip the whitespace. Without that, Transifex sees that there's a "\n" on the first line of the original but not on the future translation, and gets upset.

If this happens the template should be updated to strip whitespace and translations should be pushed to transifex.

Deployment

2012-11-28T11:55:34Z

Spaetz: /* Troubleshooting */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

= Running on Dreamhost.com =

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv: <blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:: You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add: <blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:: so that your local python will be preferred.
:: Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
::
:: You have now 1) a local ''python'' installation that you can use, and 2) ''easy_install'' will also work with your local user installation. From now on you can e.g. locally install the nose testing framework (''easy_install nose'') and use it (''python -c "import nose"'').

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install: <pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre>
::Test by leaving the mediagoblin directory and see if you can import it: <pre>python -c "import mediagoblin"</pre> looking for error messages.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.
===Open Issues===
Please fill in the blanks if you find them out:
* How to enable logging to a file or standard html logs? Console output just disappears.
* How to set up things not using sqlite. What's wrong with mySQL?

===Troubleshooting===
* First of all: invoke <pre>python passenger_wsgi.py</pre> directly from the shell. This will tell you if there are import errors etc. If this command exits without any output on the console, you have already achieved a lot.
* In ''paste.ini'' set debug=true. This will show you python backtraces directly in the web page
* You will need to configure an smtp user/passwd/server in mediagoblin.ini, so you actually get the account creation token mailed out. Hint, the relevant settings are: <blockquote><pre>email_debug_mode = false
email_sender_address = postmaster@sspaeth.de
email_smtp_host = SMTP.DOMAIN.TLD
email_smtp_user = USERNAME
email_smtp_pass = WEIRDPASSWORD</pre></blockquote>
* In case you can upload media, but it does not appear. You don't have the celery server running. Add <pre>CELERY_ALWAYS_EAGER = true</pre> to the ''[celery]'' section in mediagoblin.ini

Deployment

2012-11-28T11:51:21Z

Spaetz: move dreamhost section to correct level

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

= Running on Dreamhost.com =

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv: <blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:: You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add: <blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:: so that your local python will be preferred.
:: Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
::
:: You have now 1) a local ''python'' installation that you can use, and 2) ''easy_install'' will also work with your local user installation. From now on you can e.g. locally install the nose testing framework (''easy_install nose'') and use it (''python -c "import nose"'').

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install: <pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre>
::Test by leaving the mediagoblin directory and see if you can import it: <pre>python -c "import mediagoblin"</pre> looking for error messages.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.
===Open Issues===
Please fill in the blanks if you find them out:
* How to enable logging to a file or standard html logs? Console output just disappears.
* How to set up things not using sqlite. What's wrong with mySQL?

===Troubleshooting===
* First of all: invoke <pre>python passenger_wsgi.py</pre> directly from the shell. This will tell you if there are import errors etc. If this command exits without any output on the console, you have already achieved a lot.
* In ''paste.ini'' set debug=true. This will show you python backtraces directly in the web page
* You will need to setup an smtp user/passwd/server, so you actually get the account creation token mailed out.

Deployment

2012-11-28T11:44:00Z

Spaetz: /* Set up an WSGI environment on Dreamhost */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv: <blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:: You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add: <blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:: so that your local python will be preferred.
:: Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
::
:: You have now 1) a local ''python'' installation that you can use, and 2) ''easy_install'' will also work with your local user installation. From now on you can e.g. locally install the nose testing framework (''easy_install nose'') and use it (''python -c "import nose"'').

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install: <pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre>
::Test by leaving the mediagoblin directory and see if you can import it: <pre>python -c "import mediagoblin"</pre> looking for error messages.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.
===Open Issues===
Please fill in the blanks if you find them out:
* How to enable logging to a file or standard html logs? Console output just disappears.
* How to set up things not using sqlite. What's wrong with mySQL?

===Troubleshooting===
* First of all: invoke <pre>python passenger_wsgi.py</pre> directly from the shell. This will tell you if there are import errors etc. If this command exits without any output on the console, you have already achieved a lot.
* In ''paste.ini'' set debug=true. This will show you python backtraces directly in the web page
* You will need to setup an smtp user/passwd/server, so you actually get the account creation token mailed out.

Deployment

2012-11-28T11:38:34Z

Spaetz: /* Install mediagoblin as a site package */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv: <blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:: You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add: <blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:: so that your local python will be preferred.
:: Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
::
:: You have now 1) a local ''python'' installation that you can use, and 2) ''easy_install'' will also work with your local user installation. From now on you can e.g. locally install the nose testing framework (''easy_install nose'') and use it (''python -c "import nose"'').

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install: <pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre>
::Test by leaving the mediagoblin directory and see if you can import it: <pre>python -c "import mediagoblin"</pre> looking for error messages.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:36:18Z

Spaetz: /* Setup virtualenv to install local python packages */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv: <blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:: You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add: <blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:: so that your local python will be preferred.
:: Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
::
:: You have now 1) a local ''python'' installation that you can use, and 2) ''easy_install'' will also work with your local user installation. From now on you can e.g. locally install the nose testing framework (''easy_install nose'') and use it (''python -c "import nose"'').

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:31:22Z

Spaetz: /* Set up your python virtualenv */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[#Install a local python|python installation stuff]] and you'll only need to [[#Setup virtualenv to install local python packages|install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will also work with your local user installation.

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:30:35Z

Spaetz: /* Set up your python virtualenv */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has python 2.6 or 2.7 installed already, you can skip the [[Install a local python|#python installation stuff]] and you'll only need to [[Setup virtualenv to install local python packages|#install virtualenv]].

====Install a local python====
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack with <pre>tar xvjf Python-XXX.tar.bz2</pre>
# ''cd'' into the directory and compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/<USERNAME>/local/bin/python. You might get warnings about some modules not being able to compile. :It was tcl/tk and bzip2 mainly, but things still worked out overall.
:
:You should now be able to invoke <tt>~/local/bin/python</tt> and fall into a shell of your new python (exit with ctrl-d). Congrats, you have now a new python 2.7 that you can use. However, you will need to be able to install additional packages as a user and this is what virtualenv allows.

====Setup virtualenv to install local python packages====
# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will also work with your local user installation.

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:21:35Z

Spaetz: /* Set up your python virtualenv */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

dreamhost.com servers come with python 2.4 and 2.5 installed which is too old for mediagoblin. This means you need to compile and install a newer python (don't worry this is really not difficult on dreamhost servers). In order to be able to install python packages for a local user without touching system files, we need to setup a python ''virtualenv''. Fortunately, this is not too tricky either. If your server has a python 2.6 or 2.7 installed already, you can skip the python installation stuff and you'll only need virtualenv.

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python). You will get a few warnings about some modules not being able to compile. It was tcl/tk and bzip2 mainly, but things still worked out overall.
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will also work with your local user installation.

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:09:18Z

Spaetz: /* Running on Dreamhost.com */

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

== Running on Dreamhost.com ==

===Set up your python virtualenv===

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will work with your local installation.

===Install mediagoblin as a site package===

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

===Set up an WSGI environment on Dreamhost===

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

Deployment

2012-11-28T11:08:46Z

Spaetz: Add Deployment on Dreamhost section

This page could use a lot of work. For now, a few smaller deployment tips!

See also: http://docs.mediagoblin.org/deploying.html (some of which may belong here)

= FCGI script =

This works great with the apache config example below :)

<pre>#!/path/to/mediagoblin/bin/python

# Written in 2011 by Christopher Allan Webber
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication along
# with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.

from paste.deploy import loadapp
from flup.server.fcgi import WSGIServer

CONFIG_PATH = '/path/to/mediagoblin/paste.ini'

def launch_fcgi():
ccengine_wsgi_app = loadapp('config:' + CONFIG_PATH)
WSGIServer(ccengine_wsgi_app).run()

if __name__ == '__main__':
launch_fcgi()</pre>

= Apache 2 Config with fcgid =

Note that the libapache2-mod-fcgi in Debian is in the nonfree section, and MediaGoblin users will want to avoid that. Instead, libapache2-mod-fcgid can be used, but requires a slightly different configuration.

<pre>
<VirtualHost *:80>
ServerName media.example.com
ServerAlias www.media.example.com

DocumentRoot /path/to/mediagoblin

Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /mgoblin_static>
Order allow,deny
Allow from all
</Directory>

<Directory /mgoblin_media>
Order allow,deny
Allow from all
</Directory>

<Directory /path/to/mediagoblin/>
SetHandler fcgid-script
Options +ExecCGI
FcgidWrapper /path/to/mediagoblin/mg.fcgi
order allow,deny
allow from all
</Directory>

</VirtualHost>
</pre>

= Apache Config Example =
This configuration example uses mod_fastcgi.

To install and enable mod_fastcgi on a Debian/Ubuntu based system:
<pre># apt-get install libapache2-mod-suexec libapache2-mod-fastcgi
# a2enmod suexec
# a2enmod fastcgi</pre>

Sample configuration:
<pre>
<VirtualHost *:80>
ServerName mediagoblin.yourdomain.tld
ServerAdmin webmaster@yourdoimain.tld
DocumentRoot /var/www/
# Custom log files
CustomLog /var/log/apache2/mediagobling_access.log combined
ErrorLog /var/log/apache2/mediagoblin_error.log

# Serve static and media files via alias
Alias /mgoblin_static/ /path/to/mediagoblin/mediagoblin/static/
Alias /mgoblin_media/ /path/to/mediagoblin/user_dev/media/public/

# Rewrite all URLs to fcgi, except for static and media urls
RewriteEngine On
RewriteRule ^(mgoblin_static|mgoblin_media)($|/) - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /mg.fcgi/$1 [QSA,L]

# Allow access to static and media directories
<Directory /path/to/mediagoblin/mediagoblin/static>
Order allow,deny
Allow from all
</Directory>
<Directory /path/to/mediagoblin/mediagoblin/user_dev/media/public>
Order allow,deny
Allow from all
</Directory>

# Connect to fcgi server
FastCGIExternalServer /var/www/mg.fcgi -host 127.0.0.1:26543
</VirtualHost>
</pre>
Then, you need to make sure mediagoblin is running in fcgi mode:
<pre>cd /path/to/mediagoblin
./lazyserver.sh --server-name=fcgi fcgi_host=127.0.0.1 fcgi_port=26543</pre>

Note: there may be several ways to improve this configuration

= Juju =

There is a juju [https://juju.ubuntu.com/Charms charm] available for deploying mediagoblin into EC2 or on your local box. [https://juju.ubuntu.com/ juju] is available in Ubuntu 11.10 and later, though it is recommended that you pull it from [https://launchpad.net/~juju/+archive/pkgs| the juju PPA], which includes backported packages going back to Ubuntu 11.10. To use the juju charm, install juju and configure either the [https://juju.ubuntu.com/docs/provider-configuration-local.html local provider] or one of the cloud API providers, currently the [https://juju.ubuntu.com/docs/provider-configuration-ec2.html EC2 provider] is the best supported and works not only with Amazon Web Services but also OpenStack clouds. There is also a newer native OpenStack API provider which is known to support HP Cloud.
<pre>
# if you have not bootstrapped
juju bootstrap
mkdir ~/charms
bzr init-repo ~/charms/precise
bzr branch lp:~clint-fewbar/charms/precise/mediagoblin/trunk ~/charms/precise/mediagoblin
juju deploy --repository ~/charms local:mediagoblin
juju expose mediagoblin
</pre>

Currently the charm is volatile, deploying from trunk, and deploys a single-server version of MediaGoblin only. It will eventually relate to the existing juju charms for other supported data stores to allow one to scale out their MediaGoblin instance.

= ArchLinux init scripts =

[http://whird.jpope.org/2012/04/14/mediagoblin-archlinux-rcd-scripts Jeremy Pope has written a nice blogpost] on how to add init scripts to deploy MediaGoblin with both the python paste http server and the celery deployments separated.

If you want a simpler setup and don't want to deploy celery separately, consider either turning CELERY_ALWAYS_EAGER to true in the paste init script described above, or check out [http://chimo.chromic.org/2012/03/01/mediagoblin-init-script-on-archlinux/ Chimo's guide].

=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

User Experience

2012-11-28T11:08:16Z

Spaetz: Remove dreamhost instructions and move to Deployment page

User Experience

2012-11-28T11:07:34Z

Spaetz: /* Set up an WSGI environment on Dreamhost */

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
<blockquote><pre>import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)</pre></blockquote>
# Set up the database by issueing: <pre>gmg dbupdate</pre>
# (optional but recommended) Serve the static files directly from the webserver.
:In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static
:and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
: and mediagoblin/mediagoblin/themes to public/theme_static
:
:so it is displayed directly. This step might be different depending on your web server configuration. There is no reason that static
:files need to go through all the python indirection when they can be served directly by nginx/apache/...
:
:In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin... you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

User Experience

2012-11-28T11:04:25Z

Spaetz: /* Set up your python virtualenv */

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>
:This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
:<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>
:You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
:<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>
:so that your local python will be preferred.
:Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
:You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)

# Set up the database by issueing: gmg dbupdate
# (optional but recommended) Serve the static files directly from the webserver.
In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static

and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
and mediagoblin/mediagoblin/themes to public/theme_static

so it is displayed directly. This step might be different depending
on your web server configuration. There is no reason that static
files need to go through all the python indirection when they can be
served directly by nginx/apache/...

In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin...
you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

User Experience

2012-11-28T11:01:55Z

Spaetz: /* Install mediagoblin as a site package */

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>so that your local python will be preferred.
Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
:* In the mediagoblin directory issue:
:<blockquote><pre>python setup.py</pre></blockquote>
:* You will also need to: easy_install lxml
:* Python-image was trickier to install:
:<blockquote><pre>easy_install --find-links http://www.pythonware.com/products/pil/ Imaging</pre></blockquote>
:test by leaving the mediagoblin directory and see if you can import it:
:<blockquote><pre>python<ENTER>import mediagoblin<CTRL-D></pre></blockquote>
:looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)

# Set up the database by issueing: gmg dbupdate
# (optional but recommended) Serve the static files directly from the webserver.
In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static

and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
and mediagoblin/mediagoblin/themes to public/theme_static

so it is displayed directly. This step might be different depending
on your web server configuration. There is no reason that static
files need to go through all the python indirection when they can be
served directly by nginx/apache/...

In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin...
you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

User Experience

2012-11-28T10:59:08Z

Spaetz: /* Set up your python virtualenv */

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
<blockquote><pre>PATH=~/local/virtenv/bin:~/local/bin:${PATH}</pre></blockquote>so that your local python will be preferred.
Log out, log in again and test python" to see which version will be invoked. It should be the new python. Check "which easy_install" to see if the one in local/virtenv would be executed.
You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
- In the mediagoblin directory issue:
python setup.py

- You will also need to: easy_install lxml
- Python-image was trickier to install:
easy_install --find-links http://www.pythonware.com/products/pil/ Imaging

test by leaving the mediagoblin directory and see if you can import it:
python<ENTER>import mediagoblin<CTRL-D>
looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)

# Set up the database by issueing: gmg dbupdate
# (optional but recommended) Serve the static files directly from the webserver.
In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static

and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
and mediagoblin/mediagoblin/themes to public/theme_static

so it is displayed directly. This step might be different depending
on your web server configuration. There is no reason that static
files need to go through all the python indirection when they can be
served directly by nginx/apache/...

In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin...
you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

User Experience

2012-11-28T10:57:26Z

Spaetz: fight the formatting

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
<blockquote><pre>./configure --prefix=$HOME/local
make
make install</pre></blockquote>This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
<blockquote><pre>~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv</pre></blockquote>You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
PATH=~/local/virtenv/bin:~/local/bin:${PATH}

so that your local python will be preferred. Log out, log in again and test
"python" to see which version will be invoked. It should be the new python.
Check "which easy_install" to see if the one in local/virtenv would be executed

You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
- In the mediagoblin directory issue:
python setup.py

- You will also need to: easy_install lxml
- Python-image was trickier to install:
easy_install --find-links http://www.pythonware.com/products/pil/ Imaging

test by leaving the mediagoblin directory and see if you can import it:
python<ENTER>import mediagoblin<CTRL-D>
looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)

# Set up the database by issueing: gmg dbupdate
# (optional but recommended) Serve the static files directly from the webserver.
In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static

and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
and mediagoblin/mediagoblin/themes to public/theme_static

so it is displayed directly. This step might be different depending
on your web server configuration. There is no reason that static
files need to go through all the python indirection when they can be
served directly by nginx/apache/...

In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin...
you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

User Experience

2012-11-28T10:39:33Z

Spaetz: Running on Dreamhost

We need help doing user experience testing! This means users testing our software, observing what does and doesn't work for them, and recording that.

If you're here to help (HOORAY!) go to the testing instance set up by Caleb Davis: http://omgmg.dyndns.org:6543/ [EDIT: This link has been down since 2011 something, take a look at the [[Live instances]] instead]

Sign up for an account'''*''', add some pictures'''**''' and play around. Take some notes and then either set up an account on this wiki and add your thoughts to this page or email them to press@mediagoblin.org. Please include your operating system and what browser you're using.

'''*''' Your email validation link may be in your spam folder! 
'''**''' NOTHING ON THIS INSTANCE IS PERMANENT. This is for user experience testing only... your pics will be wiped!

You'll be able to give us the best feedback if you don't look at anyone else's notes before you start. Thanks for helping us with usability!! We really appreciate it!

= User notes go in this section =

=== From Jenny on Google Chrome 13.0.782.220 in Mac OSX 10.6.8 ===
* login ok, uploading file ok.
* can enter profile description but it doesn't seem to show up anywhere?
* no crash after attemping to upload a non-image and then uploading a real image (jpg)
* uploaded a sideways image and there is no way to rotate it.

=== From Jenny on Safari 5.1 in Mac OSX 10.6.8 ===
* login ok, uploading ok
* same problem with profile description - it's filled in but doesn't appear in the profile.
* everything seems to work ok.

=== From Deb using Ubuntu 10.04, Lucid Lynx (Netbook remix version on an Aspire One) with Firefox version 3.6.18 for Ubuntu on 9.8.2011 ===

* could still use a little note explaining how tags work
* submission is easy
* seems odd that I can't add a picture of myself to my profile on a picture site
* will people be able to search by pic tags? or search for users?
* will people be able to group pics into albums?
* maybe we could have something that is more obviously a dashboard than clicking on the username

=== From Jenny on Google Chrome 14.0.835.124 beta-m in Windows XP Professional ===
*Log in ok, comments ok, deleting files works now.
*Profile info only shows up if the website is filled in.
*Adding a .bmp crashes chrome.
*Other image types seem to work - tif, gif, png, jpg.
*Adding other non-images give a message that it is not an image (txt, pdf, mdi).
*The <- -> buttons say 'Temporary button holder' beneath them.
*The .tif image doesn't display when browsing individual photos, just in the overall view.

=== From Jenny on IE7 in Windows XP Professional ===
*Log in ok, comments ok, editing and deleting ok, uploading ok.
*Display - the profile website runs into the photos. The photos line up exactly with no space between them. Everything is top-justified rather than centered.
*The tif image doesn't display on the page for that image (where you can comment on it) - it does display on all other pages though.
*The save changes button is cut off so you only see the letters 'SAVE CHA'.
*The "Profile Edited" or "Posted Comment" comment dialog box displays over the username and logout buttons, as does the <- -> arrows. These also say 'Temporary button holder' which seems wrong.
=== Running on Dreamhost.com ===

====Set up your python virtualenv====

# Download the latest virtualenv: http://pypi.python.org/packages/source/v/virtualenv/XXX
# Download the latest python: http://python.org/ftp/python/XXX/Python-XXX.tar.bz2
# Unpack both
# Compile and install python locally:
./configure --prefix=$HOME/local
make
make install

This will install python (I used 2.7.3) into /home/spaetz/local/... (e.g. .../bin/python)
# Install the virtualenv:
~/local/bin/python ~/virtualenv-1.8/virtualenv.py $HOME/local/virtenv

You will now have: ~/local/virtenv/bin/python
# In ~/.bash_profile add:
PATH=~/local/virtenv/bin:~/local/bin:${PATH}

so that your local python will be preferred. Log out, log in again and test
"python" to see which version will be invoked. It should be the new python.
Check "which easy_install" to see if the one in local/virtenv would be executed

You have now a local python installation that you can use, and easy_install will work with your local installation.

====Install mediagoblin as a site package====

# Check out mediagoblin from git to e.g. ~/mediagoblin
# Install MediaGoblin and all dependencies for MediaGoblin with easy_install.
- In the mediagoblin directory issue:
python setup.py

- You will also need to: easy_install lxml
- Python-image was trickier to install:
easy_install --find-links http://www.pythonware.com/products/pil/ Imaging

test by leaving the mediagoblin directory and see if you can import it:
python<ENTER>import mediagoblin<CTRL-D>
looking for errors.

====Set up an WSGI environment on Dreamhost====

# Enable the mod_passenger setting for ruby/python in the domains web panel
# ''cd'' into the domain directory (e.g. ~/media.sspaeth.de for me)
# Copy mediagoblin.ini and paste.ini from the ~/mediagoblin directory here
# Create passenger_wsgi.py in your domain directory (e.g. ~/media.sspaeth.de for me):
import sys, os
INTERP = "/home/<username>/local/virtenv/bin/python"
#INTERP is present twice so that the new python interpreter knows the actual executable path
if sys.executable != INTERP: os.execl(INTERP, INTERP, *sys.argv)

from paste.deploy import loadapp
application = loadapp('config:/home/mediagoblin/media.sspaeth.de/paste.ini')

#If in case of errors, all you get are mysterious error 500, you can set debug=true in paste.ini to see stack traces
# Otherwise, add this:
#from paste.exceptions.errormiddleware import ErrorMiddleware
#application = ErrorMiddleware(application, debug=True)

# Set up the database by issueing: gmg dbupdate
# (optional but recommended) Serve the static files directly from the webserver.
In paste.ini in this section: [composite:routing] comment out the static files:
#/mgoblin_static/ = mediagoblin_static
#/theme_static/ = theme_static

and symlink the mediagobin/mediagoblin/static directoy to public/mgoblin_static
and mediagoblin/mediagoblin/themes to public/theme_static

so it is displayed directly. This step might be different depending
on your web server configuration. There is no reason that static
files need to go through all the python indirection when they can be
served directly by nginx/apache/...

In case you want to delete your git checkout after the installation (you don't need it, since you installed the mediagoblin package to ~/local/virtenv/lib/python2.7/mediagoblin...
you should do the symlinking from there.

= Past notes =

Are here, http://wiki.mediagoblin.org/User_Experience_Past_Notes

= General thoughts on running a user experience test =

Could someone with experience with this fill in info here? ;)

I (Jan-Christoph Borchardt) write a thesis at the moment on [http://owncloud.iuk.hdm-stuttgart.de/apps/files_publiclink/get.php?token=6c766212ba094bea08bf1bb800b3e1e7c785388e Coordinating low-cost usability testing in independent free & open source software projects] 
There are many small tips and recipes on how to do your own testing. Especially look into the ''Methods'' part. 
Please let me know if you have any other experiences with testing, I intend on regularly updating that document and release the full version freely licensed once it’s done as well as some kind of a ''quick start guide''.

MediaTypeRefactor

2012-11-22T15:47:09Z

Spaetz: /* Mime type */

We're planning to extend the media type system so that it's more like plugins. This page is to document some of the things we wish media types to be able to accomplish.

== Accurately describe mimetype ==

In feeds and etc, we want to share the mimetype of the entry, and maybe of the individual files? Should this be on a per-entry or a per-filetype basis?

== Additional field types ==
===File size===
For MRSS atom feeds (and probably also in the media "home" page, we need the file size of the media. Currently it is not stored at all. spaetz has a branch that implements a MediaEntry().file_size property. This works OK with local storages as it pulls the files and gets the file size on demand. But on remote storages (Amazon S3), we don't want to pull all files just to create the atom feed. We will therefore need to store the file size for each main media. Should this simply become part of the main MediaEntry table? Should it be part of an "extended Media Entry" table that is only queried on demand? I guess as we need this for all file types, so it does not make sense to put it in the per-type meta data table...
Elrond says: I think, we should have filesizes stored in the MedaFiles table. Because each resolution has its own filesize.

=== Mime type ===
Feeds etc need to be able to specify the mime type of a media file. Currently there is no way to get at the file's mime type. We'll need to think whether we store this per-file, simply in an extra field, or in an extra MimeType table? Or...?
<nowiki>16:13 < Elrond> We had a discussion on mimetype detection from bytes:
16:13 < Elrond> >>> import magic; ms = magic.open(magic.MAGIC_MIME_TYPE); ms.load();
ms.file("really_a_jpg.png")
16:13 < Elrond> 'image/jpeg'
16:14 < Elrond> Works also:
16:14 < Elrond> >>> ms.buffer(file("really_a_jpg.png").read(20))
16:14 < Elrond> 'image/jpeg'</nowiki>

MediaTypeRefactor

2012-11-22T15:00:48Z

Spaetz:

MediaTypeRefactor

2012-11-22T14:40:09Z

Spaetz: /* File size */

We're planning to extend the media type system so that it's more like plugins. This page is to document some of the things we wish media types to be able to accomplish.

== Accurately describe mimetype ==

In feeds and etc, we want to share the mimetype of the entry, and maybe of the individual files? Should this be on a per-entry or a per-filetype basis?

== Additional field types ==
===File size===
For MRSS atom feeds (and probably also in the media "home" page, we need the file size of the media. Currently it is not stored at all. spaetz has a branch that implements a MediaEntry().file_size property. This works OK with local storages as it pulls the files and gets the file size on demand. But on remote storages (Amazon S3), we don't want to pull all files just to create the atom feed. We will therefore need to store the file size for each main media. Should this simply become part of the main MediaEntry table? Should it be part of an "extended Media Entry" table that is only queried on demand? I guess as we need this for all file types, so it does not make sense to put it in the per-type meta data table...
=== Mime type ===
Feeds etc need to be able to specify the mime type of a media file. Currently there is no way to get at the file's mime type. We'll need to think whether we store this per-file, simply in an extra field, or in an extra MimeType table? Or...?

MediaTypeRefactor

2012-11-22T14:36:54Z

Spaetz: