You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by jo...@apache.org on 2014/01/06 16:18:22 UTC
[32/50] git commit: [#5424] specify syntax highlighting
[#5424] specify syntax highlighting
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/e0e9df27
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/e0e9df27
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/e0e9df27
Branch: refs/heads/cj/6992
Commit: e0e9df274d24c72157da7b31f7b2f252c1f638ee
Parents: de9c818
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Fri Dec 13 16:06:14 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:34 2014 +0000
----------------------------------------------------------------------
Allura/docs/administration.rst | 10 +++--
Allura/docs/extending.rst | 4 +-
Allura/docs/installation.rst | 32 +++++++++------
Allura/docs/scm_host.rst | 77 ++++++++++++++++++++++++++++---------
4 files changed, 90 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/e0e9df27/Allura/docs/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/administration.rst b/Allura/docs/administration.rst
index 303d778..b4f69f5 100644
--- a/Allura/docs/administration.rst
+++ b/Allura/docs/administration.rst
@@ -70,9 +70,11 @@ from an Allura server. They do require various python packages to be installed
and possibly a local Allura codebase set up.
One such script is `wiki-copy.py` which reads the wiki pages from one Allura wiki
-instance and uploads them to another Allura wiki instance. It can be run as::
+instance and uploads them to another Allura wiki instance. It can be run as:
-$ python scripts/wiki-copy.py --help
+.. code-block:: console
+
+ $ python scripts/wiki-copy.py --help
Site Notifications
@@ -80,7 +82,9 @@ Site Notifications
Allura has support for site-wide notifications that appear below the site header,
but there is currently no UI for managing them. They can easily be inserted via
-manual mongo queries, however::
+manual mongo queries, however:
+
+.. code-block:: console
> db.site_notification.insert({
... active: true,
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/e0e9df27/Allura/docs/extending.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/extending.rst b/Allura/docs/extending.rst
index c241d5f..7fb46da 100644
--- a/Allura/docs/extending.rst
+++ b/Allura/docs/extending.rst
@@ -40,7 +40,9 @@ A listing of available 3rd-party extensions is at https://forge-allura.apache.or
To disable any Allura entry point, simply add an entry in your ``.ini`` config file
with names and values corresponding to entry points defined in any ``setup.py`` file.
-For example if you have ForgeImporter set up, but want to disable the google code importers::
+For example if you have ForgeImporter set up, but want to disable the google code importers:
+
+.. code-block:: ini
disable_entry_points.allura.project_importers = google-code
disable_entry_points.allura.importers = google-code-tracker, google-code-repo
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/e0e9df27/Allura/docs/installation.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/installation.rst b/Allura/docs/installation.rst
index aaa6de6..ef41f15 100644
--- a/Allura/docs/installation.rst
+++ b/Allura/docs/installation.rst
@@ -31,13 +31,19 @@ Configuring Optional Features
The `development.ini` file has many options you can explore and configure. It is geared towards development, so you will want to review
carefully and make changes for production use.
+To run SVN and Git services, see the :doc:`scm_host` page.
+
+Some features may be added as separate `Allura extensions <https://forge-allura.apache.org/p/allura/wiki/Extensions/>`_
+
Enabling inbound email
^^^^^^^^^^^^^^^^^^^^^^
Allura can listen for email messages and update tools and artifacts. For example, every ticket has an email address, and
-emails sent to that address will be added as comments on the ticket. To set up the SMTP listener, run::
+emails sent to that address will be added as comments on the ticket. To set up the SMTP listener, run:
+
+.. code-block:: shell-session
-(env-allura)~/src/forge/Allura$ nohup paster smtp_server development.ini > ~/logs/smtp.log &
+ (env-allura)~/src/forge/Allura$ nohup paster smtp_server development.ini > ~/logs/smtp.log &
By default this uses port 8825. Depending on your mail routing, you may need to change that port number.
And if the port is in use, this command will fail. You can check the log file for any errors.
@@ -47,17 +53,21 @@ Enabling RabbitMQ
^^^^^^^^^^^^^^^^^^
For faster notification of background jobs, you can use RabbitMQ. Assuming a base setup from the INSTALL, run these commands
-to install rabbitmq and set it up::
+to install rabbitmq and set it up:
-(env-allura)~$ sudo aptitude install rabbitmq-server
-(env-allura)~$ sudo rabbitmqctl add_user testuser testpw
-(env-allura)~$ sudo rabbitmqctl add_vhost testvhost
-(env-allura)~$ sudo rabbitmqctl set_permissions -p testvhost testuser "" ".*" ".*"
-(env-allura)~$ pip install amqplib==0.6.1 kombu==1.0.4
+.. code-block:: shell-session
+
+ (env-allura)~$ sudo aptitude install rabbitmq-server
+ (env-allura)~$ sudo rabbitmqctl add_user testuser testpw
+ (env-allura)~$ sudo rabbitmqctl add_vhost testvhost
+ (env-allura)~$ sudo rabbitmqctl set_permissions -p testvhost testuser "" ".*" ".*"
+ (env-allura)~$ pip install amqplib==0.6.1 kombu==1.0.4
Then edit Allura/development.ini and change `amqp.enabled = false` to `amqp.enabled = true` and uncomment the other `amqp` settings.
-If your `paster taskd` process is still running, restart it::
+If your `paster taskd` process is still running, restart it:
+
+.. code-block:: shell-session
-(env-allura)~/src/forge/Allura$ pkill -f taskd
-(env-allura)~/src/forge/Allura$ nohup paster taskd development.ini > ~/logs/taskd.log &
+ (env-allura)~/src/forge/Allura$ pkill -f taskd
+ (env-allura)~/src/forge/Allura$ nohup paster taskd development.ini > ~/logs/taskd.log &
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/e0e9df27/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index 090cd70..10532f4 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -15,6 +15,8 @@
specific language governing permissions and limitations
under the License.
+.. _scm_hosting:
+
Git and Subversion Hosting Installation
==========================================================
@@ -29,11 +31,16 @@ Git
We'll cover the basics to get you going. For additional options and details,
see http://git-scm.com/docs/git-http-backend and http://git-scm.com/book/en/Git-on-the-Server
and subsequent chapters. The instructions here assume an
-Ubuntu system, but should be similar on other systems::
+Ubuntu system, but should be similar on other systems.
+
+.. code-block:: console
sudo a2enmod proxy rewrite
sudo vi /etc/apache2/sites-available/default
- # and add the following within the <VirtualHost block
+
+And add the following text within the `<VirtualHost>` block:
+
+.. code-block:: apache
SetEnv GIT_PROJECT_ROOT /srv/git
SetEnv GIT_HTTP_EXPORT_ALL
@@ -54,6 +61,10 @@ Ubuntu system, but should be similar on other systems::
Satisfy Any
</LocationMatch>
+Then exit vim (`<esc> :wq`) and run:
+
+.. code-block:: shell-session
+
sudo service apache2 reload
To test that it's working, run: `git ls-remote http://localhost/git/p/test/git/`
@@ -129,7 +140,9 @@ These instructions are based on the documentation in `Debootstrap Chroot`_. and
#. Install debootstrap schroot
-#. Append the following text to the file /etc/schroot/schroot.conf::
+#. Append the following text to the file /etc/schroot/schroot.conf
+
+.. code-block:: ini
[scm]
description=Ubuntu Chroot for SCM Hosting
@@ -137,7 +150,9 @@ These instructions are based on the documentation in `Debootstrap Chroot`_. and
directory=/var/chroots/scm
script-config=scm/config
-#. Create a directory /etc/schroot/scm and populate it with some files::
+#. Create a directory /etc/schroot/scm and populate it with some files:
+
+.. code-block:: console
# mkdir /etc/schroot/scm
# cat > /etc/schroot/scm/config <<EOF
@@ -161,12 +176,16 @@ These instructions are based on the documentation in `Debootstrap Chroot`_. and
hosts
EOF
-#. Create a directory /var/chroots/scm and create the bootstrap environment. (You may substitute a mirror from the `ubuntu mirror list`_ for archive.ubuntu.com::
+#. Create a directory /var/chroots/scm and create the bootstrap environment. (You may substitute a mirror from the `ubuntu mirror list`_ for archive.ubuntu.com)
+
+.. code-block:: console
$ sudo mkdir -p /var/chroots/scm
$ sudo debootstrap --variant=buildd --arch amd64 --components=main,universe --include=git,mercurial,subversion,openssh-server,slapd,ldap-utils,ldap-auth-client,curl maverick /var/chroots/scm http://archive.ubuntu.com/ubuntu/
-#. Test that the chroot is installed by entering it::
+#. Test that the chroot is installed by entering it:
+
+.. code-block:: console
# schroot -c scm -u root
(scm) # logout
@@ -174,20 +193,26 @@ These instructions are based on the documentation in `Debootstrap Chroot`_. and
Configure OpenLDAP in the Chroot
--------------------------------------------------------------
-#. Copy the ldap-setup script into the chroot environment::
+#. Copy the ldap-setup script into the chroot environment:
+
+.. code-block:: console
$ sudo cp Allura/ldap-setup.py Allura/ldap-userconfig.py /var/chroots/scm
$ sudo chmod +x /var/chroots/scm/ldap-*.py
-#. Log in to the chroot environment::
+#. Log in to the chroot environment:
+
+.. code-block:: console
# schroot -c scm -u root
-#. Run the setup script, following the prompts::
+#. Run the setup script, following the prompts:
+
+.. code-block:: console
(scm) # python /ldap-setup.py
-In particular, you will need to anwer the following questions (substitute your custom suffix if you are not using dc=localdomain):
+In particular, you will need to answer the following questions (substitute your custom suffix if you are not using dc=localdomain):
* Should debconf manage LDAP configuration? **yes**
* LDAP server Uniform Resource Identifier: **ldapi:///**
@@ -203,7 +228,9 @@ In particular, you will need to anwer the following questions (substitute your c
Update the chroot ssh configuration
-------------------------------------------------
-* Update the file /var/chroot/scm/etc/ssh/sshd_config, changing the port directive::
+* Update the file /var/chroot/scm/etc/ssh/sshd_config, changing the port directive:
+
+.. code-block:: guess
# Port 22
Port 8022
@@ -211,37 +238,51 @@ Update the chroot ssh configuration
Setup the Custom FUSE Driver
-------------------------------------
-#. Copy the accessfs script into the chroot environment::
+#. Copy the accessfs script into the chroot environment:
+
+.. code-block:: console
$ sudo cp fuse/accessfs.py /var/chroots/scm
-#. Configure allura to point to the chrooted scm environment::
+#. Configure allura to point to the chrooted scm environment:
+
+.. code-block:: console
$ sudo ln -s /var/chroots/scm /git
$ sudo ln -s /var/chroots/scm /hg
$ sudo ln -s /var/chroots/scm /svn
-#. Log in to the chroot environment & install packages::
+#. Log in to the chroot environment & install packages:
+
+.. code-block:: console
# schroot -c scm -u root
(scm) # apt-get install python-fuse
-#. Create the SCM directories::
+#. Create the SCM directories:
+
+.. code-block:: console
(scm) # mkdir /scm /scm-repo
-#. Mount the FUSE filesystem::
+#. Mount the FUSE filesystem:
+
+.. code-block:: console
(scm) # python /accessfs.py /scm-repo -o allow_other -s -o root=/scm
-#. Start the SSH daemon::
+#. Start the SSH daemon:
+
+.. code-block:: console
(scm) # /etc/init.d/ssh start
Configure Allura to Use the LDAP Server
------------------------------------------------
-Set the following values in your .ini file::
+Set the following values in your .ini file:
+
+.. code-block:: ini
auth.method = ldap