aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBen Sturmfels <ben@sturm.com.au>2021-03-08 11:14:20 +1100
committerBen Sturmfels <ben@sturm.com.au>2021-03-08 11:14:20 +1100
commit4f53c4b17c1c92a4a222ab61732e1c5489ff2639 (patch)
treea25d35a246922564a80ac3c6cc65c505c4a47ccd /docs
parent84b54b18eaebdd02bafc5b0563dc83ed798afa0a (diff)
downloadmediagoblin-4f53c4b17c1c92a4a222ab61732e1c5489ff2639.tar.lz
mediagoblin-4f53c4b17c1c92a4a222ab61732e1c5489ff2639.tar.xz
mediagoblin-4f53c4b17c1c92a4a222ab61732e1c5489ff2639.zip
Fix raw image plugin installation docs [#5523].
Dependencies need to be installed from PyPI in Debian 10/11 due to missing python3-py3exiv2 package.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/siteadmin/media-types.rst18
-rw-r--r--docs/source/siteadmin/relnotes.rst1
2 files changed, 14 insertions, 5 deletions
diff --git a/docs/source/siteadmin/media-types.rst b/docs/source/siteadmin/media-types.rst
index 9b2e4d9d..6c7409eb 100644
--- a/docs/source/siteadmin/media-types.rst
+++ b/docs/source/siteadmin/media-types.rst
@@ -178,9 +178,17 @@ Configuring video
Raw image
=========
-To enable raw image you need to install pyexiv2::
+MediaGoblin can extract and display the JPEG preview from RAW images.
- # Debian and co.
+To enable raw image you need to install the Python library ``py3exiv2``. This
+library is not currently available for Debian 10 or 11 but can be installed from
+the Python Package Index after installing the build dependencies::
+
+ # Debian 10/11
+ sudo apt install libexiv2-dev libboost-python-devn
+ ./bin/pip install py3pyexiv2
+
+ # Debian 12 (currently not released)
sudo apt install python3-pyexiv2
Add ``[[mediagoblin.media_types.raw_image]]`` under the ``[plugins]``
@@ -188,10 +196,10 @@ section in your ``mediagoblin.ini`` and restart MediaGoblin.
Run::
- $ ./bin/gmg dbupdate
+ ./bin/gmg dbupdate
-Restart MediaGoblin (and Celery if applicable). Now you should be able to submit
-raw images, and MediaGoblin should extract the JPEG preview from them.
+Restart MediaGoblin (and Celery if applicable). You should now be able to submit
+raw images.
ASCII art
diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst
index 2ddeb466..1292e114 100644
--- a/docs/source/siteadmin/relnotes.rst
+++ b/docs/source/siteadmin/relnotes.rst
@@ -34,6 +34,7 @@ carefully, or at least skim over it.
**Bug fixes:**
+- Fix raw image plugin installation instruction [#5523] (Ben Sturmfels)
- Pin sqlalchemy to fix due to changed internals [#5624] (Charlotte Koch)
- Fix test suite to pass 100% (Ben Sturmfels)
- Make LDAP plugin Python 3 compatible [#5607] (Olivier Mehani)