diff options
Diffstat (limited to 'docs/source')
-rw-r--r-- | docs/source/index.rst | 2 | ||||
-rw-r--r-- | docs/source/plugindocs/ldap.rst | 2 | ||||
-rw-r--r-- | docs/source/siteadmin/commandline-upload.rst | 41 | ||||
-rw-r--r-- | docs/source/siteadmin/relnotes.rst | 103 |
4 files changed, 146 insertions, 2 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index e7fda4ad..3ead6136 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -44,6 +44,7 @@ MediaGoblin website. It is written for site administrators. siteadmin/relnotes siteadmin/theming siteadmin/plugins + siteadmin/commandline-upload .. _core-plugin-section: @@ -61,6 +62,7 @@ Part 2: Core plugin documentation plugindocs/basic_auth plugindocs/openid plugindocs/persona + plugindocs/ldap Part 3: Plugin Writer's Guide diff --git a/docs/source/plugindocs/ldap.rst b/docs/source/plugindocs/ldap.rst new file mode 100644 index 00000000..3938c0c7 --- /dev/null +++ b/docs/source/plugindocs/ldap.rst @@ -0,0 +1,2 @@ +.. include:: ../../../mediagoblin/plugins/ldap/README.rst + diff --git a/docs/source/siteadmin/commandline-upload.rst b/docs/source/siteadmin/commandline-upload.rst new file mode 100644 index 00000000..be19df58 --- /dev/null +++ b/docs/source/siteadmin/commandline-upload.rst @@ -0,0 +1,41 @@ +.. MediaGoblin Documentation + + Written in 2011, 2012 by MediaGoblin contributors + + 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/>. + +====================== +Command-line uploading +====================== + +Want to submit media via the command line? It's fairly easy to do:: + + ./bin/gmg addmedia username your_media.jpg + +This will submit the file "your_media.jpg" to be a media entry +associated with the user "username". + +You can get help on all the available options by running:: + + ./bin/gmg addmedia --help + +Here's a longer example that makes use of more options:: + + ./bin/gmg addmedia aveyah awesome_spaceship.png \ + --title "My awesome spaceship" \ + --description "Flying my awesome spaceship, since I'm an awesome pilot" \ + --license "http://creativecommons.org/licenses/by-sa/3.0/" \ + --tags "spaceships, pilots, awesome" \ + --slug "awesome-spaceship" + +You can also pass in the `--celery` option if you would prefer that +your media be passed over to celery to be processed rather than be +processed immediately. + diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst index 8f34e145..3542bdcb 100644 --- a/docs/source/siteadmin/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst @@ -21,6 +21,105 @@ This chapter has important information for releases in it. If you're upgrading from a previous release, please read it carefully, or at least skim over it. +0.6.1 +===== + +This is a short, bugfix release. + +**Do this to upgrade** + +1. Update to the latest release. If checked out from git, run: + ``git fetch && git checkout -q v0.6.1`` +2. Make sure to run + ``./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate`` + +This release switches the default terms of service to be off by +default and corrects some mistakes in the default terms of service. + +Turning the terms of service on is very easy, just set ``show_tos`` in +the ``[mediagoblin]`` section of your config to ``true``. + + +0.6.0 +===== + +**Do this to upgrade** + +1. Update to the latest release. If checked out from git, run: + ``git fetch && git checkout -q v0.6.0`` +2. Make sure to run + ``./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate`` + +That's it, probably! If you run into problems, don't hesitate to +`contact us <http://mediagoblin.org/pages/join.html>`_ +(IRC is often best). + +This tool has a lot of new tools for administrators, hence the +nickname "Lore of the Admin"! + +**New features:** + +- New tools to control how much users can upload, both as a general + user limit, or per file. + + You can set this with the following options in your mediagoblin + config file: `upload_limit` and `max_file_size`. Both are integers + in megabytes. + + There is an option to control how much each individual user can + upload too, though an interface for this is not yet exposed. See + the "uploaded" field on the core__users table. + +- MediaGoblin now contains an authentication plugin for ldap! You + can turn on the mediagoblin.plugins.ldap plugin to make use of + this. See the documentation: :ref:`ldap-plugin` + +- There's a new command line upload tool! At long last! See + `./bin/gmg addmedia --help` for info on how to use this. + +- There's now a terms of service document included in MediaGoblin. + It's turned on by default, but you can turn it off if you prefer, + just set the configuration option of `show_tos` in the [mediagoblin] + section of your config to false. + + Alternately, you can override the template for the terms of service + document to set up your own. + +- We have a lot of new administrative tooling features! + - There's a built-in privileges/permissions system now. + Administrators are given access to modifying these parameters + from a user administration panel. + - Users can submit reports about other problematic users or media + and administrators are given tools to resolve said reports and + ban/unban users if needed. + +- New version of video.js is included with MediaGoblin. Slight + amount of skinning to match the MediaGoblin look, otherwise also + uses the new default skin. + +Developer-oriented changes: + +- New developer tool for quickly setting up a development environment + in `devtools/make_example_database.sh`. Requires doing a checkout + of our other tool `mg_dev_environments <https://gitorious.org/mediagoblin/mg-dev-environments/>`_ + (probably in the parent Directory) though! +- A "foundations" framework has entered into the codebase. + This is mostly just relevant to coders, but it does mean that it's + much easier to add database structures that need some entries filled + automatically by default. +- Refactoring to the authentication code and the reprocessing code + + +0.5.1 +===== + +v0.5.1 is a bugfix release... the steps are the same as for 0.5.1. + +**Bugfixes:** + +- python 2.6 compatibility restored +- Fixed last release's release notes ;) + 0.5.0 ===== @@ -48,9 +147,9 @@ now. Otherwise, jump in and have fun! :) 3. We have made a script to transition your ``mediagoblin_local.ini`` file for - you. This script can be found at + you. This script can be found at: -.. add a link to the script + http://mediagoblin.org/download/0.5.0_config_converter.py If you run into problems, don't hesitate to `contact us <http://mediagoblin.org/pages/join.html>`_ |