aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/api/client_register.rst11
-rw-r--r--docs/source/siteadmin/configuration.rst28
-rw-r--r--docs/source/siteadmin/media-types.rst10
-rw-r--r--docs/source/siteadmin/relnotes.rst126
4 files changed, 169 insertions, 6 deletions
diff --git a/docs/source/api/client_register.rst b/docs/source/api/client_register.rst
index 08f92c47..9c29bafc 100644
--- a/docs/source/api/client_register.rst
+++ b/docs/source/api/client_register.rst
@@ -15,7 +15,7 @@
Registering a Client
====================
-To use the GNU MediaGoblin API you need to use the dynamic client registration. This has been adapted from the `OpenID specification <https://openid.net/specs/openid-connect-registration-1_0.html>`_, this is the only part of OpenID that is being used to serve the purpose to provide the client registration which is used in OAuth.
+To use the GNU MediaGoblin API you need to use the dynamic client registration. This has been adapted from the `OpenID specification <https://openid.net/specs/openid-connect-registration-1_0.html>`_, this is the only part of OpenID that is being used to serve the purpose to provide the client registration which is used in OAuth.
The endpoint is ``/api/client/register``
@@ -39,8 +39,8 @@ application_type
application_name
**optional** - This is the name of your client
-logo_url
- **optional** - This is a URL of the logo image for your client
+logo_uri
+ **optional** - This is a URI of the logo image for your client
redirect_uri
**optional** - This is a space seporated list of pre-registered URLs for use at the Authorization Server
@@ -93,8 +93,8 @@ Using the response we got above we can update the information and add new inform
"client_id": "vwljdhUMhhNbdKizpjZlxv",
"client_secret": "hJtfhaQzgKerlLVdaeRAgmbcstSOBLRfgOinMxBCHcb",
"application_type": "web",
- "application_name": "MyClient!",
- "logo_url": "https://myclient.org/images/my_logo.png",
+ "application_name": "MyClient!",
+ "logo_uri": "https://myclient.org/images/my_logo.png",
"contacts": "myemail@someprovider.com another_developer@provider.net",
}
@@ -155,4 +155,3 @@ redirect_uris must be space-separated URLs.
URI <URI> is not a valid URI
This is when your URI is invalid.
-
diff --git a/docs/source/siteadmin/configuration.rst b/docs/source/siteadmin/configuration.rst
index 3da5cdd9..dd0d6cd9 100644
--- a/docs/source/siteadmin/configuration.rst
+++ b/docs/source/siteadmin/configuration.rst
@@ -109,6 +109,34 @@ they sound like.
- email_smtp_user
- email_smtp_pass
+Changing data directory
+-----------------------
+
+MediaGoblin by default stores your data in wherever ``data_basedir``.
+This can be changed by changing the value in your ``mediagoblin.ini`` file
+for example::
+
+ [DEFAULT]
+ data_basedir = "/var/mediagoblin/user_data"
+
+For efficiency reasons MediaGoblin doesn't serve these files itself and
+instead leaves that to the webserver. You will have to alter the location
+to match the path in ``data_basedir``.
+
+If you use ``lazyserver.sh`` you need to change the ``paste.ini`` file::
+
+ [app:mediagoblin]
+ /mgoblin_media = /var/mediagoblin/user_data
+
+If you use nginx you need to change the config::
+
+ # Instance specific media:
+ location /mgoblin_media/ {
+ alias /var/mediagoblin/user_data;
+ }
+
+Once you have done this you will need to move any existing media you had in the
+old directory to the new directory so existing media still can be displayed.
All other configuration changes
-------------------------------
diff --git a/docs/source/siteadmin/media-types.rst b/docs/source/siteadmin/media-types.rst
index 44ad02bb..f8030081 100644
--- a/docs/source/siteadmin/media-types.rst
+++ b/docs/source/siteadmin/media-types.rst
@@ -264,3 +264,13 @@ Run
./bin/gmg dbupdate
+Blog (HIGHLY EXPERIMENTAL)
+==========================
+
+MediaGoblin has a blog media type, which you might notice by looking
+through the docs! However, it is *highly experimental*. We have not
+security reviewed this, and it acts in a way that is not like normal
+blogs (the blogposts are themselves media types!).
+
+So you can play with this, but it is not necessarily recommended yet
+for production use! :)
diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst
index 3542bdcb..16899a0b 100644
--- a/docs/source/siteadmin/relnotes.rst
+++ b/docs/source/siteadmin/relnotes.rst
@@ -21,6 +21,132 @@ 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.7.1
+=====
+
+This is a purely bugfix release. Important changes happened since
+0.7.0; if running MediaGoblin 0.7.0, an upgrade is highly recommended;
+see below. This release is especially useful if you have been running
+postgres and have been receiving seemingly random database transaction
+errors.
+
+**Do this to upgrade**
+
+1. Update to the latest release. If checked out from git, run:
+ ``git fetch && git checkout -q v0.7.1 && git submodule init && git submodule update``
+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).
+
+**Bugfixes/improvements:**
+
+- The *MOST IMPORTANT* change in this release:
+ Disabling a couple of non-critical features that were causing
+ database transaction issues. (These should be back by 0.8.0.)
+
+ + Disabled the "checking if the database is up to date at
+ mediagoblin startup" feature
+ + Disabled the garbage collection stuff by default for now
+ (You can set garbage_collection under the config mediagoblin
+ header to something other than 0 to turn it back on for now, but
+ it's potentially risky for the moment.)
+
+- Some fixes to the 0.7.0 docs
+- Fixed Sandy 70s speedboat navbar by updating git submodule
+- Added support for cr2 files in raw_image media type
+- Added a description to setup.py
+- Collection and CollectionItem objects now have nicer in-python representations
+- Fixed unicode error with raw image mediatype logging
+- Fixed #945 "Host metadata does not confirm to spec (/.well-known/meta-data)"
+
+ + Add XRD+XML formatting for /.well-known/host-meta
+ + Add /.well-known/webfinger API to lookup user hrefs
+
+- deleteuser gmg subcommand now fails gracefully
+- Removed a false download link from setup.py
+
+0.7.0
+====
+
+**Do this to upgrade**
+
+1. Update to the latest release. If checked out from git, run:
+ ``git fetch && git checkout -q v0.7.0 && git submodule init && git submodule update``
+2. Make sure to run
+ ``./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate``
+
+(NOTE: earlier versions of the 0.7.0 release instructions left out the
+``git submodule init`` step! If you did an upgrade earlier based on
+these instructions and your theme looks weirdly aligned, try running
+the following:)
+
+ ``git submodule init && git submodule update``
+
+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).
+
+**New features:**
+
+- New mobile upload API making use of the
+ `Pump API <https://github.com/e14n/pump.io/blob/master/API.md>`_
+ (which will be the foundation for MediaGoblin's federation)
+- New theme: Sandy 70s Speedboat!
+
+- Metadata features! We also now have a json-ld context.
+
+- Many improvements for archival institutions, including metadata
+ support and featuring items on the homepage. With the (new!)
+ archivalook plugin enabled, featuring media is possible.
+ Additionally, metadata about the particular media item will show up
+ in the sidebar.
+
+ In the future these plugins may be separated, but for now they have
+ come together as part of the same plugin.
+
+- There is a new gmg subcommand called batchaddmedia that allows for
+ uploading many files at once. This is aimed to be useful for
+ archival institutions and groups where there is an already existing
+ and large set of available media that needs to be included.
+- Speaking of, the call to postgres in the makefile is fixed.
+- We have a new, generic media-page context hook that allows for
+ adding context depending on the type of media.
+- Tired of video thumbnails breaking during processing all the time?
+ Good news, everyone! Video thumbnail generation should not fail
+ frequently anymore. (We think...)
+- You can now set default permissions for new users in the config.
+
+- bootstrap.sh / gnu configuration stuff still exists, but moves to be
+ experimental-bootstrap.sh so as to not confuse newcomers. There are
+ some problems currently with the autoconf stuff that we need to work
+ out... we still have interest in supporting it, though help is
+ welcome.
+
+- MediaGoblin now checks whether or not the database is up to date
+ when starting.
+- Switched to `Skeleton <http://www.getskeleton.com/>`_ as a system for
+ graphic design.
+- New gmg subcommands for administrators:
+ - A "deletemedia" command
+ - A "deleteuser" command
+- We now have a blogging media type... it's very experimental,
+ however. Use with caution!
+- We have switched to exifread as an external library for reading EXIF
+ data. It's basically the same thing as before, but packaged
+ separately from MediaGoblin.
+- Many improvements to internationalization. Also (still rudimentary,
+ but existant!) RTL language support!
+
+**Known issues:**
+ - The host-meta is now json by default; in the spec it should be xml by
+ default. We have done this because of compatibility with the pump
+ API. We are checking with upstream to see if there is a way to
+ resolve this discrepancy.
+
+
0.6.1
=====