heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Removed note about installing from master. Clarified root/nonroot usage.

Browse Source 
There was a note informing the user that they should be aware that we
encourage them to install from the *master* branch, but we no longer
do that. If they follow our deployment docs, they will pull in &
use the *stable* branch.

Also clarified some root / non-root system usage by either specifying
a leading *hash* symbol to indicate a root-based command, or a
dollar sign to indicate a non-root command.
This commit is contained in:
Jim Campbell 2015-03-30 23:47:49 -05:00
parent c3075e9178
commit 9a1ba0e87f
1 changed files with 21 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/source/siteadmin/deploying.rst
View File

@ -153,14 +153,10 @@ The following command (entered as root or with sudo) will create a
system account with a username of ``mediagoblin``. You may choose a different system account with a username of ``mediagoblin``. You may choose a different
username if you wish.:: username if you wish.::
useradd --system --user-group mediagoblin # useradd --system --user-group mediagoblin
No password will be assigned to this account, and you will not be able 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:: to log in as this user. To switch to this account, enter::
sudo -u mediagoblin /bin/bash # (if you have sudo permissions)
or::
su mediagoblin -s /bin/bash # (if you have to use root permissions) su mediagoblin -s /bin/bash # (if you have to use root permissions)
@ -199,32 +195,29 @@ to suit your particular requirements::
Install MediaGoblin and Virtualenv Install MediaGoblin and Virtualenv
---------------------------------- ----------------------------------
.. note::
MediaGoblin is still developing rapidly. As a result
the following instructions recommend installing from the ``master``
branch of the git repository. Eventually production deployments will
want to transition to running from more consistent releases.
We will now clone the MediaGoblin source code repository and setup and We will now clone the MediaGoblin source code repository and setup and
configure the necessary services. Modify these commands to configure the necessary services. Modify these commands to
suit your own environment. As a reminder, you should enter these suit your own environment.
commands using your unpriviledged system account.
.. note::
As a reminder, you should enter these commands using your unpriviledged
*mediagoblin* system account.
Change to the MediaGoblin directory that you just created:: Change to the MediaGoblin directory that you just created::
cd /srv/mediagoblin.example.org $ cd /srv/mediagoblin.example.org
Clone the MediaGoblin repository and set up the git submodules:: Clone the MediaGoblin repository and set up the git submodules::
git clone https://gitorious.org/mediagoblin/mediagoblin.git -b stable $ git clone https://gitorious.org/mediagoblin/mediagoblin.git -b stable
cd mediagoblin $ cd mediagoblin
git submodule init && git submodule update $ git submodule init && git submodule update
Set up the hacking environment:: Set up the hacking environment::
./bootstrap.sh && ./configure && make $ ./bootstrap.sh && ./configure && make
The above provides an in-package install of ``virtualenv``. While this The above provides an in-package install of ``virtualenv``. While this
is counter to the conventional ``virtualenv`` configuration, it is is counter to the conventional ``virtualenv`` configuration, it is
@ -235,23 +228,20 @@ your preferred method.
Assuming you are going to deploy with FastCGI, you should also install Assuming you are going to deploy with FastCGI, you should also install
flup:: flup::
./bin/easy_install flup $ ./bin/easy_install flup
(Sometimes this breaks because flup's site is flakey. If it does for
you, try)::
./bin/easy_install https://pypi.python.org/pypi/flup/1.0.3.dev-20110405
This concludes the initial configuration of the development This concludes the initial configuration of the development
environment. In the future, when you update your environment. In the future, when you update your
codebase, you should also run:: codebase, you should also run::
git submodule update && ./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate $ git submodule update && ./bin/python setup.py develop --upgrade && ./bin/gmg dbupdate
Note: If you are running an active site, depending on your server .. note::
configuration, you may need to stop it first or the dbupdate command
may hang (and it's certainly a good idea to restart it after the Note: If you are running an active site, depending on your server
update) configuration, you may need to stop it first or the dbupdate command
may hang (and it's certainly a good idea to restart it after the
update)
Deploy MediaGoblin Services Deploy MediaGoblin Services