From 5058cd51000a5ed3093816b6f786aed7126a15ba Mon Sep 17 00:00:00 2001 From: Sam Clegg Date: Sun, 17 Mar 2013 17:39:31 -0700 Subject: Fix sphinx warnsing in docs. Add -W to sphinx options to avoid warnings in the future. --- docs/source/siteadmin/relnotes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/source/siteadmin') diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst index 84ec09b5..f0be8ecb 100644 --- a/docs/source/siteadmin/relnotes.rst +++ b/docs/source/siteadmin/relnotes.rst @@ -28,8 +28,8 @@ carefully, or at least skim over it. 2. OpenStreetMap is now a plugin, so if you want to use it, add the following to your config file:: - [plugins] - [[mediagoblin.plugins.geolocation]] + [plugins] + [[mediagoblin.plugins.geolocation]] If you have your own theme, you may need to make some adjustments to it as some theme related things may have changed in this release. If -- cgit v1.2.3 From fd5c35e54cd3c22788f583dae4ad1a04b13c07f3 Mon Sep 17 00:00:00 2001 From: Jim Campbell Date: Mon, 13 May 2013 01:04:42 -0500 Subject: docs: started refactoring of the deployment docs. several updates to make the configuration steps more explicit. --- docs/source/siteadmin/deploying.rst | 83 +++++++++++++++++++++++++++---------- 1 file changed, 62 insertions(+), 21 deletions(-) (limited to 'docs/source/siteadmin') diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index f2f71e01..326d2243 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -1,6 +1,6 @@ .. MediaGoblin Documentation - Written in 2011, 2012 by MediaGoblin contributors + Written in 2011, 2012, 2013 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 @@ -77,7 +77,7 @@ Configure PostgreSQL If you don't want/need postgres, skip this section. -These are the packages needed for Debian Wheezy (testing):: +These are the packages needed for Debian Wheezy (stable):: sudo apt-get install postgresql postgresql-client python-psycopg2 @@ -121,25 +121,62 @@ where the first ``mediagoblin`` is the database owner and the second Drop Privileges for MediaGoblin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -As MediaGoblin does not require special permissions or elevated -access, you should run MediaGoblin under an existing non-root user or -preferably create a dedicated user for the purpose of running -MediaGoblin. Consult your distribution's documentation on how to -create "system account" or dedicated service user. Ensure that it is -not possible to log in to your system with as this user. +MediaGoblin does not require special permissions or elevated +access to run. As such, the prefered way to run MediaGoblin is to +create a dedicated, unpriviledged system user for sole the purpose of running +MediaGoblin. Running MediaGoblin processes under an unpriviledged system user +helps to keep it more secure. + +The following command (entered as root or with sudo) will create a +system account with a username of ``mediagoblin``. You may choose a different +username if you wish.:: + + ``# adduser --system mediagoblin`` + +No password will be assigned to this account, and you will not be able +to log in as this user. To switch to this account, enter either:: + + ``sudo su - mediagoblin`` (if you have sudo permissions) + +or + + ``su - mediagoblin`` (if you have to use root permissions) + +You may get a warning similar to this when entering these commands:: + + ``warning: cannot change directory to /home/mediagoblin: No such file or directory`` + +You can disregard this warning. To return to your regular user account after +using the system account, just enter ``exit``. + +.. note:: + + Unless otherwise noted, the remainder of this document assumes that all + operations are performed using this unpriviledged account. + +.. _create-mediagoblin-directory: + +Create a MediaGoblin Directory +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You should create a working directory for MediaGoblin. This document assumes your local git repository will be located at -``/srv/mediagoblin.example.org/mediagoblin/`` for this documentation. -Substitute your prefer ed local deployment path as needed. +``/srv/mediagoblin.example.org/mediagoblin/``. +Substitute your prefered local deployment path as needed. + +Setting up the working directory requires that we first create the directory +with elevated priviledges, and then assign ownership of the directory +to the unpriviledged system account. -This document assumes that all operations are performed as this -user. To drop privileges to this user, run the following command:: +To do this, enter either of the following commands, changing the defaults +to suit your particular requirements:: - su - [mediagoblin] + ``sudo mkdir -p /srv/mediagoblin.example.org && sudo chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org`` + +or (as the root user) + + ``# mkdir -p /srv/mediagoblin.example.org && chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org`` -Where, "``[mediagoblin]``" is the username of the system user that will -run MediaGoblin. Install MediaGoblin and Virtualenv ---------------------------------- @@ -151,17 +188,20 @@ Install MediaGoblin and Virtualenv branch of the git repository. Eventually production deployments will want to transition to running from more consistent releases. -Issue the following commands, to create and change the working -directory. Modify these commands to reflect your own environment:: +We will now clone the MediaGoblin source code repository and setup and +configure the necessary services. Modify these commands to +suit your own environment. As a reminder, you should enter these +commands using your unpriviledged system account. - mkdir -p /srv/mediagoblin.example.org/ - cd /srv/mediagoblin.example.org/ +Change to the MediaGoblin directory that you just created:: + + cd /srv/mediagoblin.example.org Clone the MediaGoblin repository:: git clone git://gitorious.org/mediagoblin/mediagoblin.git -And set up the in-package virtualenv:: +Set up the in-package virtualenv:: cd mediagoblin (virtualenv --system-site-packages . || virtualenv .) && ./bin/python setup.py develop @@ -358,4 +398,5 @@ Security Considerations for session security. Make sure not to leak its contents anywhere. If the contents gets leaked nevertheless, delete your file and restart the server, so that it creates a new secret key. - All previous sessions will be invalifated then. + All previous sessions will be invalidated. + -- cgit v1.2.3 From 99d79749c44f3cb37faf4152762f9847292b7c0a Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Thu, 25 Jul 2013 15:15:49 -0500 Subject: Set up in-package virtualenv via make --- docs/source/siteadmin/deploying.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'docs/source/siteadmin') diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index 50fc05c5..05cf172d 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -163,12 +163,23 @@ Clone the MediaGoblin repository and set up the git submodules:: cd mediagoblin git submodule init && git submodule update -And set up the in-package virtualenv:: +Set up the in-package virtualenv via make: - (virtualenv --system-site-packages . || virtualenv .) && ./bin/python setup.py develop + ./bootstrap.sh && ./configure && make .. note:: + Prefer not to use make, or want to use the "old way" of installing + MediaGoblin (maybe you know how to use virtualenv and python + packaging)? You still can! All that the above make script is doing + is installing an in-package virtualenv and running + + ./bin/python setup.py develop + +.. :: + + (NOTE: Is this still relevant?) + If you have problems here, consider trying to install virtualenv with the ``--distribute`` or ``--no-site-packages`` options. If your system's default Python is in the 3.x series you may need to -- cgit v1.2.3 From 9b60486894e437b90592ec5354f76d7c40ffd6b6 Mon Sep 17 00:00:00 2001 From: Rodney Ewing Date: Wed, 31 Jul 2013 15:16:52 -0700 Subject: minor styling updates to docs --- docs/source/siteadmin/deploying.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'docs/source/siteadmin') diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst index a892bbd4..2f68912d 100644 --- a/docs/source/siteadmin/deploying.rst +++ b/docs/source/siteadmin/deploying.rst @@ -131,20 +131,20 @@ The following command (entered as root or with sudo) will create a system account with a username of ``mediagoblin``. You may choose a different username if you wish.:: - ``# adduser --system mediagoblin`` + adduser --system mediagoblin No password will be assigned to this account, and you will not be able to log in as this user. To switch to this account, enter either:: - ``sudo su - mediagoblin`` (if you have sudo permissions) + sudo su - mediagoblin (if you have sudo permissions) -or +or:: - ``su - mediagoblin`` (if you have to use root permissions) + su - mediagoblin (if you have to use root permissions) You may get a warning similar to this when entering these commands:: - ``warning: cannot change directory to /home/mediagoblin: No such file or directory`` + warning: cannot change directory to /home/mediagoblin: No such file or directory You can disregard this warning. To return to your regular user account after using the system account, just enter ``exit``. @@ -171,11 +171,11 @@ to the unpriviledged system account. To do this, enter either of the following commands, changing the defaults to suit your particular requirements:: - ``sudo mkdir -p /srv/mediagoblin.example.org && sudo chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org`` + sudo mkdir -p /srv/mediagoblin.example.org && sudo chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org -or (as the root user) +or (as the root user):: - ``# mkdir -p /srv/mediagoblin.example.org && chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org`` + mkdir -p /srv/mediagoblin.example.org && chown -hR mediagoblin:mediagoblin /srv/mediagobin.example.org Install MediaGoblin and Virtualenv -- cgit v1.2.3