aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristopher Allan Webber <cwebber@dustycloud.org>2013-11-14 14:17:18 -0600
committerChristopher Allan Webber <cwebber@dustycloud.org>2013-11-14 14:17:18 -0600
commita442823bc1d8bc4946749a036a5460ceea456a9b (patch)
treeabc6d915475bbb97a4a8e1c3cbf18acfaf99eaf7 /docs
parent131b74952910b2e9418f74ec4f04731829174e0a (diff)
downloadmediagoblin-a442823bc1d8bc4946749a036a5460ceea456a9b.tar.lz
mediagoblin-a442823bc1d8bc4946749a036a5460ceea456a9b.tar.xz
mediagoblin-a442823bc1d8bc4946749a036a5460ceea456a9b.zip
Documenting the command-line uploading tooling.
This commit sponsored by Libby Reinish. Thank you! :)
Diffstat (limited to 'docs')
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/siteadmin/commandline-upload.rst41
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 75a5b66e..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:
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.
+