diff options
| -rw-r--r-- | docs/source/siteadmin/commandline-upload.rst | 11 | ||||
| -rw-r--r-- | docs/source/siteadmin/configuration.rst | 44 | ||||
| -rw-r--r-- | docs/source/siteadmin/deploying.rst | 29 |
3 files changed, 44 insertions, 40 deletions
diff --git a/docs/source/siteadmin/commandline-upload.rst b/docs/source/siteadmin/commandline-upload.rst index af4fd1bd..d3847a1b 100644 --- a/docs/source/siteadmin/commandline-upload.rst +++ b/docs/source/siteadmin/commandline-upload.rst @@ -11,9 +11,9 @@ Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. -====================== -Command-line uploading -====================== +================================ +Command-line and batch uploading +================================ If you're a site administrator and have access to the server then you can use the 'addmedia' task. If you're just a user and want to upload @@ -46,9 +46,8 @@ 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. -============================ -Command-line batch uploading -============================ +Batch uploading +=============== There's another way to submit media, and it can be much more powerful, although it is a bit more complex. diff --git a/docs/source/siteadmin/configuration.rst b/docs/source/siteadmin/configuration.rst index 92d77628..488919d7 100644 --- a/docs/source/siteadmin/configuration.rst +++ b/docs/source/siteadmin/configuration.rst @@ -24,18 +24,13 @@ some configuration parameters. Well you've come to the right place! MediaGoblin's config files ========================== -When configuring MediaGoblin, there are two files you might want to -make local modified versions of, and one extra file that might be -helpful to look at. Let's examine these. +There are two main files used to configure MediaGoblin: ``mediagoblin.ini`` This is the main config file for MediaGoblin. If you want to tweak any - settings for MediaGoblin, you'll usually do that here. - -``mediagoblin.example.ini`` - When you run MediaGoblin for the first time, this default config is copied to - your new ``mediagoblin.ini``. Keep this in mind if you need to refer back to - the original settings. + settings for MediaGoblin, you'll usually do that here. This file is copied + from ``mediagoblin.example.ini`` the first time MediaGoblin runs. Keep this in + mind if you ever need to refer back to the original settings. ``paste.ini`` This is primarily a server configuration file, on the Python side @@ -47,17 +42,10 @@ helpful to look at. Let's examine these. Python server other than Waitress / plain HTTP, you might configure it here. You probably won't need to change this file very much. - -There's one more file that you certainly won't change unless you're -making coding contributions to MediaGoblin, but which can be useful to -read and reference: - -``mediagoblin/config_spec.ini`` - This file is actually a specification for mediagoblin.ini itself, as - a config file! It defines types and defaults. Sometimes it's a - good place to look for documentation... or to find that hidden - option that we didn't tell you about. :) - +Changes to these two files only take effect after restarting MediaGoblin. If you +followed your deployment guide, see the section on :ref:`restarting MediaGoblin +<restarting mediagoblin>`. If you're using ``lazyserver.sh`` or +``lazycelery.sh``, first quit with ``Ctrl-c`` and then re-run the command. Enabling extra media types or plugins may require an update to the database, so after making changes, it is also a good idea to run:: @@ -97,6 +85,7 @@ they sound like. - ``email_smtp_use_ssl`` (default is ``False``) - ``email_smtp_force_starttls`` (default is ``False``) + Changing the data directory --------------------------- @@ -126,14 +115,13 @@ If you use Nginx you need to change the config:: 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 ------------------------------- -To be perfectly honest, there are quite a few options and we haven't had -time to document them all, including Celery configuration. - -So here's a cop-out section saying that if you get into trouble, hop -onto IRC and we'll help you out. Details for the IRC channel is on the -`join page`_ of the website. - -.. _join page: http://mediagoblin.org/join/ +There are a number of other settings which aren't documented here. Currently, +the best reference for these options is ``mediagoblin/config_spec.ini`` and the +additional config specifications for each media type eg. +``mediagoblin/media_types/video/config_spec.ini``. These files are the +specification for ``mediagoblin.ini`` and define the types and default values +for each configuration option. diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index 04ac7ef8..de74479a 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -519,7 +519,7 @@ environment's setup: # Set the WorkingDirectory and Environment values to match your environment. [Unit] - Description=MediaGoblin Celeryd + Description=MediaGoblin Celery After=rabbitmq-server.service [Service] @@ -577,26 +577,43 @@ the error by entering either of:: sudo systemctl status mediagoblin-celeryd.service sudo systemctl status mediagoblin-paster.service + The above ``systemctl status`` command is also useful if you ever want to -confirm that a process is still running. If you make any changes to the service -files, you can reload the service files by entering:: +confirm that a process is still running. If you make any changes to the ".service" +files, you can reload the service files and restart MediaGoblin by entering:: sudo systemctl daemon-reload + sudo systemctl restart mediagoblin-celeryd.service + sudo systemctl restart mediagoblin-paster.service -After entering that command, you can attempt to start the Celery or Paste -processes again using ``restart`` instead of ``start``. Assuming the above was successful, you should now have a MediaGoblin server that will continue to operate, even after being restarted. Great job! +.. _restarting mediagoblin: + +Restarting MediaGoblin +---------------------- + +To restart MediaGoblin after making configuration changes, run:: + + sudo systemctl restart mediagoblin-celeryd.service + sudo systemctl restart mediagoblin-paster.service + + What next? ---------- This configuration supports upload of images only, but MediaGoblin also supports other types of media, such as audio, video, PDFs and 3D -models. For details, see the ":doc:`media-types`" documentation. +models. For details, see ":doc:`media-types`". + +For other settings and configuration options, see +":doc:`configuration`". + +To enable and configure plugins, see ":doc:`plugins`". .. Local variables: |