Return-Path: X-Original-To: apmail-incubator-allura-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-allura-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 39B0F1018B for ; Thu, 2 Jan 2014 20:23:16 +0000 (UTC) Received: (qmail 70227 invoked by uid 500); 2 Jan 2014 20:23:16 -0000 Delivered-To: apmail-incubator-allura-commits-archive@incubator.apache.org Received: (qmail 70154 invoked by uid 500); 2 Jan 2014 20:23:16 -0000 Mailing-List: contact allura-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: allura-dev@incubator.apache.org Delivered-To: mailing list allura-commits@incubator.apache.org Received: (qmail 70096 invoked by uid 99); 2 Jan 2014 20:23:16 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 02 Jan 2014 20:23:16 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id A4C859148B4; Thu, 2 Jan 2014 20:23:15 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: tvansteenburgh@apache.org To: allura-commits@incubator.apache.org Date: Thu, 02 Jan 2014 20:23:22 -0000 Message-Id: In-Reply-To: <0f50b5ef8f294561bbeb0246c7b2d176@git.apache.org> References: <0f50b5ef8f294561bbeb0246c7b2d176@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [08/14] 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/master Commit: e0e9df274d24c72157da7b31f7b2f252c1f638ee Parents: de9c818 Author: Dave Brondsema Authored: Fri Dec 13 16:06:14 2013 -0500 Committer: Tim Van Steenburgh 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 `_ + 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 ` 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 +Then exit vim (` :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 <