diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/siteadmin/commandline-upload.rst | 3 | ||||
| -rw-r--r-- | docs/source/siteadmin/configuration.rst | 24 | ||||
| -rw-r--r-- | docs/source/siteadmin/deploying.rst | 17 | ||||
| -rw-r--r-- | docs/source/siteadmin/media-types.rst | 20 | ||||
| -rw-r--r-- | docs/source/siteadmin/production-deployments.rst | 2 | ||||
| -rw-r--r-- | docs/source/siteadmin/relnotes.rst | 8 | ||||
| -rw-r--r-- | docs/source/siteadmin/theming.rst | 2 |
7 files changed, 26 insertions, 50 deletions
diff --git a/docs/source/siteadmin/commandline-upload.rst b/docs/source/siteadmin/commandline-upload.rst index ef597a44..756f5fa8 100644 --- a/docs/source/siteadmin/commandline-upload.rst +++ b/docs/source/siteadmin/commandline-upload.rst @@ -58,7 +58,7 @@ it is a bit more complex. This is an example of what a script may look like. The important part here is that you have to create the 'metadata.csv' file.:: - media:location,dcterms:title,dcterms:creator,dcterms:type + location,dcterms:title,dcterms:creator,dcterms:type "http://www.example.net/path/to/nap.png","Goblin taking a nap",,"Image" "http://www.example.net/path/to/snore.ogg","Goblin Snoring","Me","Audio" @@ -87,6 +87,7 @@ just as easy to provide this information through the correct metadata columns. - **license** is used to set a license for your piece a media for MediaGoblin's use. This must be a URI. - **title** will set the title displayed to MediaGoblin users. - **description** will set a description of your media. +- **collection-slug** will add the media to a collection, if a collection with the given slug exists. Metadata columns ---------------- diff --git a/docs/source/siteadmin/configuration.rst b/docs/source/siteadmin/configuration.rst index 6b8cd225..1b8dc9bb 100644 --- a/docs/source/siteadmin/configuration.rst +++ b/docs/source/siteadmin/configuration.rst @@ -54,30 +54,6 @@ mediagoblin/config_spec.ini option that we didn't tell you about. :) -Making local copies -=================== - -Let's assume you're doing the virtualenv setup described elsewhere in this -manual, and you need to make local tweaks to the config files. How do you do -that? Let's see. - -To make changes to mediagoblin.ini :: - - cp mediagoblin.ini mediagoblin_local.ini - -To make changes to paste.ini :: - - cp paste.ini paste_local.ini - -From here you should be able to make direct adjustments to the files, -and most of the commands described elsewhere in this manual will "notice" -your local config files and use those instead of the non-local version. - -.. note:: - - Note that all commands provide a way to pass in a specific config - file also, usually by a ``-cf`` flag. - Common changes ============== diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index c7cc2403..42fe1772 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -65,7 +65,7 @@ MediaGoblin has the following core dependencies: - `virtualenv <http://www.virtualenv.org/>`_ - `nodejs <https://nodejs.org>`_ -On a DEB-based system (e.g Debian, gNewSense, Trisquel, *buntu, and +On a DEB-based system (e.g Debian, gNewSense, Trisquel, \*buntu, and derivatives) issue the following command:: sudo apt-get install git-core python python-dev python-lxml \ @@ -240,7 +240,7 @@ Change to the MediaGoblin directory that you just created:: Clone the MediaGoblin repository and set up the git submodules:: - $ git clone git://git.savannah.gnu.org/mediagoblin.git -b stable + $ git clone https://git.savannah.gnu.org/git/mediagoblin.git -b stable $ cd mediagoblin $ git submodule init && git submodule update @@ -250,7 +250,7 @@ Clone the MediaGoblin repository and set up the git submodules:: gitorious.org shut down, we had to move. We are presently on Savannah. You may need to update your git repository location:: - $ git remote set-url origin git://git.savannah.gnu.org/mediagoblin.git + $ git remote set-url origin https://git.savannah.gnu.org/git/mediagoblin.git Set up the hacking environment:: @@ -319,13 +319,16 @@ Edit site configuration ~~~~~~~~~~~~~~~~~~~~~~~ A few basic properties must be set before MediaGoblin will work. First -make a copy of ``mediagoblin.ini`` and ``paste.ini`` for editing so the original +make a copy of ``paste.ini`` for editing so the original config files aren't lost (you likely won't need to edit the paste configuration, but we'll make a local copy of it just in case):: - $ cp -av mediagoblin.ini mediagoblin_local.ini && cp -av paste.ini paste_local.ini + $ cp -av paste.ini paste_local.ini + +``mediagoblin.ini`` does not need to be copied, because original config is +stored in ``mediagoblin.example.ini``. -Then edit mediagoblin_local.ini: +Then edit ``mediagoblin.ini``: - Set ``email_sender_address`` to the address you wish to be used as the sender for system-generated emails - Edit ``direct_remote_path``, ``base_dir``, and ``base_url`` if @@ -337,7 +340,7 @@ Configure MediaGoblin to use the PostgreSQL database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are using PostgreSQL, edit the ``[mediagoblin]`` section in your -``mediagoblin_local.ini`` and put in:: +``mediagoblin.ini`` and put in:: sql_engine = postgresql:///mediagoblin diff --git a/docs/source/siteadmin/media-types.rst b/docs/source/siteadmin/media-types.rst index 146e1aae..8f9239be 100644 --- a/docs/source/siteadmin/media-types.rst +++ b/docs/source/siteadmin/media-types.rst @@ -30,17 +30,14 @@ Enabling Media Types .. note:: Media types are now plugins -Media types are enabled in your MediaGoblin configuration file, typically it is -created by copying ``mediagoblin.ini`` to ``mediagoblin_local.ini`` and then -applying your changes to ``mediagoblin_local.ini``. If you don't already have a -``mediagoblin_local.ini``, create one in the way described. +Media types are enabled in your MediaGoblin configuration file. Most media types have additional dependencies that you will have to install. You will find descriptions on how to satisfy the requirements of each media type on this page. To enable a media type, add the the media type under the ``[plugins]`` section -in you ``mediagoblin_local.ini``. For example, if your system supported image +in you ``mediagoblin.ini``. For example, if your system supported image and video media types, then it would look like this:: [plugins] @@ -99,7 +96,7 @@ good/bad/ugly). On Debianoid systems Add ``[[mediagoblin.media_types.video]]`` under the ``[plugins]`` section in -your ``mediagoblin_local.ini`` and restart MediaGoblin. +your ``mediagoblin.ini`` and restart MediaGoblin. Run @@ -139,7 +136,7 @@ Then install ``scikits.audiolab`` for the spectrograms:: ./bin/pip install scikits.audiolab Add ``[[mediagoblin.media_types.audio]]`` under the ``[plugins]`` section in your -``mediagoblin_local.ini`` and restart MediaGoblin. +``mediagoblin.ini`` and restart MediaGoblin. Run @@ -160,7 +157,7 @@ To enable raw image you need to install pyexiv2. On Debianoid systems sudo apt-get install python-pyexiv2 Add ``[[mediagoblin.media_types.raw_image]]`` under the ``[plugins]`` -section in your ``mediagoblin_local.ini`` and restart MediaGoblin. +section in your ``mediagoblin.ini`` and restart MediaGoblin. Run @@ -184,8 +181,7 @@ library, which is necessary for creating thumbnails of ASCII art ./bin/easy_install chardet -Next, modify (and possibly copy over from ``mediagoblin.ini``) your -``mediagoblin_local.ini``. In the ``[plugins]`` section, add +Next, modify your ``mediagoblin.ini``. In the ``[plugins]`` section, add ``[[mediagoblin.media_types.ascii]]``. Run @@ -207,7 +203,7 @@ It may work on some earlier versions, but that is not guaranteed (and is surely not to work prior to Blender 2.5X). Add ``[[mediagoblin.media_types.stl]]`` under the ``[plugins]`` section in your -``mediagoblin_local.ini`` and restart MediaGoblin. +``mediagoblin.ini`` and restart MediaGoblin. Run @@ -256,7 +252,7 @@ This feature has been tested on Fedora with: It may work on some earlier versions, but that is not guaranteed. Add ``[[mediagoblin.media_types.pdf]]`` under the ``[plugins]`` section in your -``mediagoblin_local.ini`` and restart MediaGoblin. +``mediagoblin.ini`` and restart MediaGoblin. Run diff --git a/docs/source/siteadmin/production-deployments.rst b/docs/source/siteadmin/production-deployments.rst index ee915573..3d11f022 100644 --- a/docs/source/siteadmin/production-deployments.rst +++ b/docs/source/siteadmin/production-deployments.rst @@ -76,7 +76,7 @@ modify it to suit your environment's setup: ExecStartPre=/bin/mkdir -p /run/mediagoblin ExecStartPre=/bin/chown -hR mediagoblin:mediagoblin /run/mediagoblin # Celery process will run as the `mediagoblin` user after start. - Environment=MEDIAGOBLIN_CONFIG=/srv/mediagoblin.example.org/mediagoblin/mediagoblin_local.ini \ + Environment=MEDIAGOBLIN_CONFIG=/srv/mediagoblin.example.org/mediagoblin/mediagoblin.ini \ CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_celery ExecStart=/srv/mediagoblin.example.org/mediagoblin/bin/celery worker \ --logfile=/var/log/mediagoblin/celery.log \ diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst index f32ca792..1c15f249 100644 --- a/docs/source/siteadmin/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst @@ -36,7 +36,7 @@ carefully, or at least skim over it. gitorious.org shut down, we had to move. We are presently on Savannah. You may need to update your git repository location:: - git remote set-url origin git://git.savannah.gnu.org/mediagoblin.git + git remote set-url origin https://git.savannah.gnu.org/git/mediagoblin.git 0.9.0 @@ -49,7 +49,7 @@ Python 3, which is pretty cool! **Do this to upgrade** 0. If you haven't already, switch the git remote URL: - ``git remote set-url origin git://git.savannah.gnu.org/mediagoblin.git`` + ``git remote set-url origin https://git.savannah.gnu.org/git/mediagoblin.git`` 1. Update to the latest release. If checked out from git, run: ``git fetch && git checkout -q v0.9.0`` 2. Run @@ -89,7 +89,7 @@ soon as possible. **Do this to upgrade** 0. If you haven't already, switch the git remote URL: - ``git remote set-url origin git://git.savannah.gnu.org/mediagoblin.git`` + ``git remote set-url origin https://git.savannah.gnu.org/git/mediagoblin.git`` 1. Update to the latest release. If checked out from git, run: ``git fetch && git checkout -q v0.8.1`` 2. Run @@ -143,7 +143,7 @@ trouble, consider pinging the MediaGoblin list or IRC channel. **Do this to upgrade** 0. If you haven't already, switch the git remote URL: - ``git remote set-url origin git://git.savannah.gnu.org/mediagoblin.git`` + ``git remote set-url origin https://git.savannah.gnu.org/git/mediagoblin.git`` 1. If you don't have node.js installed, you'll need it for handling MediaGoblin's static web dependencies. Install this via your distribution! (In the glorious future MediaGoblin will be simply diff --git a/docs/source/siteadmin/theming.rst b/docs/source/siteadmin/theming.rst index 9c01a5b3..24f23235 100644 --- a/docs/source/siteadmin/theming.rst +++ b/docs/source/siteadmin/theming.rst @@ -43,7 +43,7 @@ want to install this theme! Don't worry, it's fairly painless. 3. ``tar -xzvf <tar-archive>`` 4. Open your configuration file (probably named - ``mediagoblin_local.ini``) and set the theme name:: + ``mediagoblin.ini``) and set the theme name:: [mediagoblin] # ... |