You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by tv...@apache.org on 2014/01/02 21:23:15 UTC
[01/14] git commit: [#5424] start configuration doc changes
Updated Branches:
refs/heads/master 58ab8ee83 -> c67efb525
[#5424] start configuration doc changes
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/62213428
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/62213428
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/62213428
Branch: refs/heads/master
Commit: 62213428e5d2df120fcd1048c0412c886aa9fc27
Parents: f839811
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 18:31:22 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:33 2014 +0000
----------------------------------------------------------------------
Allura/docs/installation.rst | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/62213428/Allura/docs/installation.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/installation.rst b/Allura/docs/installation.rst
index 48d4eef..aaa6de6 100644
--- a/Allura/docs/installation.rst
+++ b/Allura/docs/installation.rst
@@ -18,15 +18,21 @@
Installation
=================
-Installation
----------------
+Install
+-------
Our step-by-step setup instructions are in our INSTALL.markdown file. You can read it online at https://forge-allura.apache.org/p/allura/git/ci/master/tree/INSTALL.markdown You should be able to get Allura up and running in well under an hour by following those instructions.
For a faster and easier setup, see our `Vagrant/VirtualBox installation guide <https://forge-allura.apache.org/p/allura/wiki/Install%20and%20Run%20Allura%20-%20Vagrant/>`_
+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.
+
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::
@@ -37,9 +43,8 @@ By default this uses port 8825. Depending on your mail routing, you may need to
And if the port is in use, this command will fail. You can check the log file for any errors.
To change the port number, edit `development.ini` and change `forgemail.port` to the appropriate port number for your environment.
-
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::
[09/14] git commit: [#5424] forward ports for SCM services
Posted by tv...@apache.org.
[#5424] forward ports for SCM services
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/8666d130
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/8666d130
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/8666d130
Branch: refs/heads/master
Commit: 8666d13034a849bae6c5be2edf0b61f148dd707c
Parents: ea26b2a
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Thu Dec 12 15:30:55 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:34 2014 +0000
----------------------------------------------------------------------
vagrant/Vagrantfile | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/8666d130/vagrant/Vagrantfile
----------------------------------------------------------------------
diff --git a/vagrant/Vagrantfile b/vagrant/Vagrantfile
index 7572922..44c21c9 100644
--- a/vagrant/Vagrantfile
+++ b/vagrant/Vagrantfile
@@ -33,9 +33,17 @@ Vagrant.configure("2") do |config|
# Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine. In the example below,
# accessing "localhost:8080" will access port 80 on the guest machine.
- config.vm.network :forwarded_port, guest: 8080, host: 8080
- config.vm.network :forwarded_port, guest: 8983, host: 8983
-
+ # allura
+ config.vm.network :forwarded_port, guest: 8080, host: 8080, auto_correct: true
+ # solr
+ config.vm.network :forwarded_port, guest: 8983, host: 8983, auto_correct: true
+ # HTTP (svn or git or other)
+ config.vm.network :forwarded_port, guest: 80, host: 8088, auto_correct: true
+ # SVN
+ config.vm.network :forwarded_port, guest: 3690, host: 3690, auto_correct: true
+ # GIT readonly
+ config.vm.network :forwarded_port, guest: 9418, host: 9418, auto_correct: true
+
# Create a private network, which allows host-only access to the machine
# using a specific IP.
# config.vm.network :private_network, ip: "192.168.33.10"
@@ -58,7 +66,7 @@ Vagrant.configure("2") do |config|
config.vm.provider :virtualbox do |vb|
# Don't boot with headless mode
# vb.gui = true
-
+
# Use VBoxManage to customize the VM. For example to change memory:
vb.customize ["modifyvm", :id, "--memory", "1024"]
end
[11/14] git commit: [#5424] remove unused scm dirs from vagrant config
Posted by tv...@apache.org.
[#5424] remove unused scm dirs from vagrant config
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/85c1c7c6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/85c1c7c6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/85c1c7c6
Branch: refs/heads/master
Commit: 85c1c7c6e630364fceb097827621f5a68333b988
Parents: b48aac4
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Fri Dec 13 17:27:23 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:35 2014 +0000
----------------------------------------------------------------------
vagrant/manifests/ubuntu-1204-server-amd64.pp | 31 ----------------------
1 file changed, 31 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/85c1c7c6/vagrant/manifests/ubuntu-1204-server-amd64.pp
----------------------------------------------------------------------
diff --git a/vagrant/manifests/ubuntu-1204-server-amd64.pp b/vagrant/manifests/ubuntu-1204-server-amd64.pp
index ead0205..b93456e 100644
--- a/vagrant/manifests/ubuntu-1204-server-amd64.pp
+++ b/vagrant/manifests/ubuntu-1204-server-amd64.pp
@@ -115,40 +115,9 @@ file { '/home/vagrant/env-allura/lib/python2.7/site-packages/pysvn':
}
# create SCM repo dirs
-file { [ "/home/vagrant/scm", "/home/vagrant/scm/git", "/home/vagrant/scm/hg", "/home/vagrant/scm/svn" ]:
- ensure => "directory",
- owner => "vagrant",
- group => "vagrant",
- mode => 777,
-}
-
-# create symlinks to repo dirs
-file { '/git':
- ensure => "link",
- target => "/home/vagrant/scm/git",
- owner => "vagrant",
- group => "vagrant",
-}
-
-file { '/hg':
- ensure => "link",
- target => "/home/vagrant/scm/hg",
- owner => "vagrant",
- group => "vagrant",
-}
-
-file { '/svn':
- ensure => "link",
- target => "/home/vagrant/scm/svn",
- owner => "vagrant",
- group => "vagrant",
-}
-
-# create SCM repo dirs
file { [ "/srv/git", "/srv/hg", "/srv/svn" ]:
ensure => "directory",
owner => "vagrant",
group => "vagrant",
mode => 770,
}
-
[05/14] git commit: [#5424] simplify documentation nav links
Posted by tv...@apache.org.
[#5424] simplify documentation nav links
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/f8398113
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/f8398113
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/f8398113
Branch: refs/heads/master
Commit: f83981132c360da872e5dfe7ba4d0293482c7ae0
Parents: ca0d9d4
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 18:16:22 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:33 2014 +0000
----------------------------------------------------------------------
Allura/docs/_templates/layout.html | 5 +++++
Allura/docs/conf.py | 12 +++++++-----
2 files changed, 12 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/f8398113/Allura/docs/_templates/layout.html
----------------------------------------------------------------------
diff --git a/Allura/docs/_templates/layout.html b/Allura/docs/_templates/layout.html
new file mode 100644
index 0000000..d098c91
--- /dev/null
+++ b/Allura/docs/_templates/layout.html
@@ -0,0 +1,5 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+ <li><a href="https://forge-allura.apache.org/p/allura/">Allura Home</a> »</li>
+ {{ super() }}
+{% endblock %}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/f8398113/Allura/docs/conf.py
----------------------------------------------------------------------
diff --git a/Allura/docs/conf.py b/Allura/docs/conf.py
index 3029c64..7b20c15 100644
--- a/Allura/docs/conf.py
+++ b/Allura/docs/conf.py
@@ -113,7 +113,9 @@ html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+html_theme_options = {
+ 'sidebarwidth': 280, # default 230 (px)
+}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
@@ -123,7 +125,7 @@ html_theme = 'nature'
html_title = 'Allura documentation'
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+html_short_title = 'Documentation'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -155,16 +157,16 @@ html_static_path = ['_static']
#html_additional_pages = {}
# If false, no module index is generated.
-#html_use_modindex = True
+html_use_modindex = False
# If false, no index is generated.
-#html_use_index = True
+html_use_index = False
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
[06/14] git commit: [#5424] store repos on /srv instead of /tmp so
they don't disappear after reboot on most systems
Posted by tv...@apache.org.
[#5424] store repos on /srv instead of /tmp so they don't disappear after reboot on most systems
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/14911893
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/14911893
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/14911893
Branch: refs/heads/master
Commit: 14911893ee50d96390ae98bc56a3ac0269919153
Parents: 8666d13
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Thu Dec 12 18:18:47 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:34 2014 +0000
----------------------------------------------------------------------
Allura/development.ini | 16 ++++++++--------
INSTALL.markdown | 11 +++++++++++
vagrant/manifests/ubuntu-1204-server-amd64.pp | 9 +++++++++
3 files changed, 28 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/14911893/Allura/development.ini
----------------------------------------------------------------------
diff --git a/Allura/development.ini b/Allura/development.ini
index 5a3d83f..edfb794 100644
--- a/Allura/development.ini
+++ b/Allura/development.ini
@@ -109,14 +109,14 @@ static.url_base = /nf/%(build_key)s/_static_/
ew.extra_headers = [ ('Access-Control-Allow-Origin', '*') ]
# SCM settings for local development
-scm.host.ro.git = /tmp/git$path
-scm.host.rw.git = /tmp/git$path
+scm.host.ro.git = /srv/git$path
+scm.host.rw.git = /srv/git$path
# remote access varies by configuration. If you are using a vagrant VM, this should work:
-#scm.host.rw.git = ssh://vagrant@localhost:2222/tmp/git$path
-scm.host.ro.hg = /tmp/hg$path
-scm.host.rw.hg = /tmp/hg$path
-scm.host.ro.svn = file:///tmp/svn$path/
-scm.host.rw.svn = file:///tmp/svn$path/
+#scm.host.rw.git = ssh://vagrant@localhost:2222/srv/git$path
+scm.host.ro.hg = /srv/hg$path
+scm.host.rw.hg = /srv/hg$path
+scm.host.ro.svn = file:///srv/svn$path/
+scm.host.rw.svn = file:///srv/svn$path/
# SCM settings for chroot + ldap configuration. See Allura/docs/scm_host.rst
# scm.host.ro.git = git://git.localhost$path
@@ -145,7 +145,7 @@ scm.new_refresh = true
gitweb.cgi = /usr/lib/cgi-bin/gitweb.cgi
-scm.repos.root = /tmp
+scm.repos.root = /srv
scm.repos.tarball.enable = false
scm.repos.tarball.root = /usr/share/nginx/www/
scm.repos.tarball.url_prefix = http://localhost/
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/14911893/INSTALL.markdown
----------------------------------------------------------------------
diff --git a/INSTALL.markdown b/INSTALL.markdown
index f8afa23..cce192e 100644
--- a/INSTALL.markdown
+++ b/INSTALL.markdown
@@ -114,6 +114,17 @@ We have a custom config ready for use.
(env-allura)~/src/apache-solr-4.2.1/example/$ nohup java -jar start.jar > ~/logs/solr.log &
+### Create code repo directories
+
+The default configuration stores repos in `/srv`, so we need to create those directories:
+
+ sudo mkdir /srv/{git,svn,hg}
+ sudo chown $USER /srv/{git,svn,hg}
+
+If you don't have `sudo` permission or just want to store them somewhere else, change the `/srv` paths in `development.ini`
+
+If you want to set up remote access to the repositories, see <http://allura.sourceforge.net/docs/scm_host.html>
+
### Allura task processing
Allura uses a background task service called "taskd" to do async tasks like sending emails, and indexing data into solr, etc. Let's get it running
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/14911893/vagrant/manifests/ubuntu-1204-server-amd64.pp
----------------------------------------------------------------------
diff --git a/vagrant/manifests/ubuntu-1204-server-amd64.pp b/vagrant/manifests/ubuntu-1204-server-amd64.pp
index be00025..ead0205 100644
--- a/vagrant/manifests/ubuntu-1204-server-amd64.pp
+++ b/vagrant/manifests/ubuntu-1204-server-amd64.pp
@@ -143,3 +143,12 @@ file { '/svn':
owner => "vagrant",
group => "vagrant",
}
+
+# create SCM repo dirs
+file { [ "/srv/git", "/srv/hg", "/srv/svn" ]:
+ ensure => "directory",
+ owner => "vagrant",
+ group => "vagrant",
+ mode => 770,
+}
+
[12/14] git commit: [#5424] bump docutils>=0.9 for :code:
Posted by tv...@apache.org.
[#5424] bump docutils>=0.9 for :code:
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/94ae6ddb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/94ae6ddb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/94ae6ddb
Branch: refs/heads/master
Commit: 94ae6ddba6c0f4428e90786e5c59c74f4ee857f3
Parents: 85c1c7c
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Mon Dec 16 17:15:28 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:35 2014 +0000
----------------------------------------------------------------------
requirements-common.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/94ae6ddb/requirements-common.txt
----------------------------------------------------------------------
diff --git a/requirements-common.txt b/requirements-common.txt
index 5184ad4..7f48285 100644
--- a/requirements-common.txt
+++ b/requirements-common.txt
@@ -8,8 +8,8 @@ colander==0.9.3
# dep of pypeline
Creoleparser==0.7.3
decorator==3.3.2
-# dep of pypeline
-docutils==0.8.1
+# dep of pypeline, sphinx
+docutils==0.9
EasyWidgets==0.2dev-20130716
faulthandler==2.1
feedparser==5.0.1
[10/14] git commit: [#5424] reorganize doc TOC, remove old stuff,
add links to external documentation
Posted by tv...@apache.org.
[#5424] reorganize doc TOC, remove old stuff, add links to external documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/ea26b2a8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/ea26b2a8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/ea26b2a8
Branch: refs/heads/master
Commit: ea26b2a8a1f3d82f5a3478268eb1ab9f821bad1b
Parents: 6221342
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 18:56:12 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:34 2014 +0000
----------------------------------------------------------------------
Allura/docs/administration.rst | 15 ++++++
Allura/docs/index.rst | 29 ++++-------
Allura/docs/tutorials/tool.rst | 58 +++++++++++++++++++++
Allura/docs/tutorials/wiki-tool.rst | 87 --------------------------------
4 files changed, 84 insertions(+), 105 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/ea26b2a8/Allura/docs/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/administration.rst b/Allura/docs/administration.rst
index 19c2e53..303d778 100644
--- a/Allura/docs/administration.rst
+++ b/Allura/docs/administration.rst
@@ -93,3 +93,18 @@ user closes it manually. An `impressions` value of 0 will show the notification
indefinitely (until closed). The notification content can contain HTML. Only the
most recent notification will be shown, unless it has `active:false`, in which case
no notification will be shown.
+
+
+Using Projects and Tools
+------------------------
+
+We currently don't have any further documentation for basic operations of managing
+users, projects, and tools on Allura. However, SourceForge has help docs that cover
+these functions https://sourceforge.net/p/forge/documentation/Docs%20Home/ Note
+that this documentation also covers some SourceForge features that are not part of Allura.
+
+
+Public API Documentation
+------------------------
+
+Allura's web api is currently documented at https://sourceforge.net/p/forge/documentation/Allura%20API/
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/ea26b2a8/Allura/docs/index.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/index.rst b/Allura/docs/index.rst
index ebbd0bf..81c4426 100644
--- a/Allura/docs/index.rst
+++ b/Allura/docs/index.rst
@@ -20,7 +20,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Introducing the *Allura* Platform:
+Introduction
=====================================================================
.. toctree::
@@ -28,7 +28,7 @@ Introducing the *Allura* Platform:
intro
-Getting Started
+Running Allura
=====================================================================
.. toctree::
@@ -36,29 +36,29 @@ Getting Started
installation
administration
- platform_tour
scm_host
migration
-Writing a Allura based app
+Developing Allura
=====================================================================
.. toctree::
:maxdepth: 3
- tutorials/wiki-tool
+ platform
+ platform_tour
+ guides/message_bus
+ guides/email
+ guides/permissions
-Inside the Platform Components
+Extending Allura
=====================================================================
.. toctree::
:maxdepth: 3
- platform
- guides/message_bus
- guides/email
- guides/permissions
extending
+ tutorials/tool
API Documentation
==================
@@ -69,19 +69,12 @@ API Documentation
api/*
-Frequently Asked Questions
+Background Info
=====================================================================
.. toctree::
:maxdepth: 1
faq
-
-Project References
-=====================================================================
-
-.. toctree::
- :maxdepth: 1
-
online
Indices and tables
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/ea26b2a8/Allura/docs/tutorials/tool.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/tutorials/tool.rst b/Allura/docs/tutorials/tool.rst
new file mode 100644
index 0000000..2ab768d
--- /dev/null
+++ b/Allura/docs/tutorials/tool.rst
@@ -0,0 +1,58 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Creating your first Allura Tool
+=====================================================================
+
+Tim Van Steenburgh has written a `series of posts guiding you through
+writing an Allura tool <https://sourceforge.net/u/vansteenburgh/allura-plugin-development/>`_.
+There is also a `companion git repo <https://sourceforge.net/u/vansteenburgh/plugin-tutorial/ci/master/tree/>`_.
+
+
+Testing your Tool
+===========================
+
+Testing the controllers and models of an Allura tool is fairly
+straightforward. Generally, you should follow the example of tests in the
+`allura/tests/functional` directory for controller tests and
+`allura.tests.model` for model tests. For functional tests, the Allura platform
+provides a convenient "test harness" :class:`allura.controllers.test.TestController` controller
+class which is used as the application root for the
+:class:`allura.tests.TestController` class.
+
+In order to test your new tool controllers, you simply need to use the `self.app.get()`
+and `self.app.post()` methods of your test controller. The test harness makes
+all the tools available in the system available under the URL /*entry point
+name*/. So to test the :mod:`allura.ext.project_home` tool, for instance, we
+need only write the following::
+
+ from allura.tests import TestController
+
+ class TestProjectHome(TestController):
+
+ def test_home(self):
+ r = self.app.get('/home/')
+
+Whenever you use the :class:`allura.tests.TestController` app property, the
+test harness sets up the context so that `c.project` is always the
+`projects/test` project and whichever tool name you request is mounted at its
+entry point (so the Wiki tool will be mounted at /Wiki/). `c.user` is always
+set to the `test-admin` user to avoid authentication issues.
+
+The framework used to generate the WSGI environment for testing your tools is
+provided by the `WebTest <http://pythonpaste.org/webtest/>`_ module, where you can
+find further documentation for the `.get()` and `.post()` methods.
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/ea26b2a8/Allura/docs/tutorials/wiki-tool.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/tutorials/wiki-tool.rst b/Allura/docs/tutorials/wiki-tool.rst
deleted file mode 100644
index 1e5d4ff..0000000
--- a/Allura/docs/tutorials/wiki-tool.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Creating your first Allura Tool
-=====================================================================
-
-Adding your Allura Tool to a Allura Install
-=====================================================================
-
-Writing a Wiki Tool Part 1: Pages
-=====================================================================
-
-Writing a wiki Tool Part 2: Links
-=====================================================================
-
-Writing a wiki Tool Part 3: Revisions
-=====================================================================
-
-Testing your Tool
-===========================
-
-Testing the controllers and models of an Allura tool is fairly
-straightforward. Generally, you should follow the example of tests in the
-`allura/tests/functional` directory for controller tests and
-`allura.tests.model` for model tests. For functional tests, the Allura platform
-provides a convenient "test harness" :class:`allura.controllers.test.TestController` controller
-class which is used as the application root for the
-:class:`allura.tests.TestController` class.
-
-In order to test your new tool controllers, you simply need to use the `self.app.get()`
-and `self.app.post()` methods of your test controller. The test harness makes
-all the tools available in the system available under the URL /*entry point
-name*/. So to test the :mod:`allura.ext.project_home` tool, for instance, we
-need only write the following::
-
- from allura.tests import TestController
-
- class TestProjectHome(TestController):
-
- def test_home(self):
- r = self.app.get('/home/')
-
-Whenever you use the :class:`allura.tests.TestController` app property, the
-test harness sets up the context so that `c.project` is always the
-`projects/test` project and whichever tool name you request is mounted at its
-entry point (so the Wiki tool will be mounted at /Wiki/). `c.user` is always
-set to the `test-admin` user to avoid authentication issues.
-
-The framework used to generate the WSGI environment for testing your tools is
-provided by the `WebTest <http://pythonpaste.org/webtest/>`_ module, where you can
-find further documentation for the `.get()` and `.post()` methods.
-
-Testing Allura models is also straightforward, though it usually requires
-setting the pylons context object `c` before your test. An example of this
-technique follows::
-
- import mock
- from pylons import tmpl_context as c, app_globals as g
-
- from allura.lib.app_globals import Globals
- from allura import model as M
-
- def setUp():
- g._push_object(Globals())
- c._push_object(mock.Mock())
- g.set_project('projects/test')
- g.set_app('hello')
- c.user = M.User.query.get(username='test-admin')
-
-Testing the tasks and events is similar to testing models. Generally, you will
-simply want to call your `@task` and `@event_handler` methods directly rather
-than setting up a full mocking infrastructure, though it is possible to use the
-MonQTask model in the allura model if you wish to do more functional/integration testing.
[03/14] git commit: [#5424] minor improvements to installation text
Posted by tv...@apache.org.
[#5424] minor improvements to installation text
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/81cf8e4d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/81cf8e4d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/81cf8e4d
Branch: refs/heads/master
Commit: 81cf8e4d95758841aac7284cc90400df3208e194
Parents: 58ab8ee
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 17:25:52 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:33 2014 +0000
----------------------------------------------------------------------
Allura/docs/installation.rst | 6 +++---
INSTALL.markdown | 5 ++---
2 files changed, 5 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/81cf8e4d/Allura/docs/installation.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/installation.rst b/Allura/docs/installation.rst
index c8eba12..48d4eef 100644
--- a/Allura/docs/installation.rst
+++ b/Allura/docs/installation.rst
@@ -18,12 +18,12 @@
Installation
=================
-Easy Setup
+Installation
---------------
-Our easy setup instructions are in our INSTALL.markdown file. You can read it online at https://forge-allura.apache.org/p/allura/git/ci/master/tree/INSTALL.markdown
+Our step-by-step setup instructions are in our INSTALL.markdown file. You can read it online at https://forge-allura.apache.org/p/allura/git/ci/master/tree/INSTALL.markdown You should be able to get Allura up and running in well under an hour by following those instructions.
-You should be able to get Allura up and running in well under an hour by following those instructions.
+For a faster and easier setup, see our `Vagrant/VirtualBox installation guide <https://forge-allura.apache.org/p/allura/wiki/Install%20and%20Run%20Allura%20-%20Vagrant/>`_
Enabling inbound email
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/81cf8e4d/INSTALL.markdown
----------------------------------------------------------------------
diff --git a/INSTALL.markdown b/INSTALL.markdown
index 000ce36..f8afa23 100644
--- a/INSTALL.markdown
+++ b/INSTALL.markdown
@@ -42,9 +42,7 @@ Before we begin, you'll need to install some system packages.
~$ sudo aptitude install git-core default-jre-headless python-dev libssl-dev libldap2-dev libsasl2-dev libjpeg8-dev zlib1g-dev
-To install MongoDB 2.2.3, follow the instructions here:
-
- <http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/>
+To install MongoDB, follow the instructions here: <http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/>
Optional, for SVN support:
@@ -148,6 +146,7 @@ register a new project in your own forge, visit /p/add_project
* Read more documentation: <http://allura.sourceforge.net/docs/>
* Including how to enable extra features: <http://allura.sourceforge.net/docs/installation.html>
+* Ask questions and discuss Allura on the <http://mail-archives.apache.org/mod_mbox/incubator-allura-dev/>
* Run the test suite (slow): `$ ALLURA_VALIDATION=none ./run_tests`
* File bug reports at <https://sourceforge.net/p/allura/tickets/new/> (login required)
* Contribute code according to this guide: <https://forge-allura.apache.org/p/allura/wiki/Contributing%20Code/>
[02/14] git commit: [#5424] change theme to nature (looks nicer;
TOC menu on left)
Posted by tv...@apache.org.
[#5424] change theme to nature (looks nicer; TOC menu on left)
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/ca0d9d45
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/ca0d9d45
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/ca0d9d45
Branch: refs/heads/master
Commit: ca0d9d4577f07a3fe34d6c018b7942773efd8b1d
Parents: a8cca91
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 17:44:19 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:33 2014 +0000
----------------------------------------------------------------------
Allura/docs/conf.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/ca0d9d45/Allura/docs/conf.py
----------------------------------------------------------------------
diff --git a/Allura/docs/conf.py b/Allura/docs/conf.py
index f7d8757..3029c64 100644
--- a/Allura/docs/conf.py
+++ b/Allura/docs/conf.py
@@ -108,7 +108,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'sphinxdoc'
+html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
[13/14] git commit: [#5424] instructions for git/svn setup (no auth)
Posted by tv...@apache.org.
[#5424] instructions for git/svn setup (no auth)
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/b48aac48
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/b48aac48
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/b48aac48
Branch: refs/heads/master
Commit: b48aac48178f50375b110ee8a75ae47c5a190003
Parents: e0e9df2
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Fri Dec 13 17:26:31 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:35 2014 +0000
----------------------------------------------------------------------
Allura/docs/scm_host.rst | 232 ++++++++++++++++++++++++++----------------
1 file changed, 143 insertions(+), 89 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/b48aac48/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index 10532f4..f500703 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -23,22 +23,30 @@ Git and Subversion Hosting Installation
Allura can manage and display Git and SVN repositories, but it doesn't
automatically run the git and svn services for you. Here we'll describe how
to set up standard git and svn services to work with Allura, so that you can
-checkout and commit code with those repositories.
+checkout and commit code with those repositories. The instructions here assume
+an Ubuntu system, but should be similar on other systems.
+
+.. note::
+
+ For developing with Allura or simple testing of Allura, you do not need to run
+ these services. You can use local filesystem access to git and svn, which
+ works with no additional configuration.
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.
+and subsequent chapters.
-.. code-block:: console
+.. code-block:: bash
+ sudo mkdir /srv/git
+ sudo chown allura:allura /srv/git # or other user, as needed (e.g. "vagrant")
sudo a2enmod proxy rewrite
sudo vi /etc/apache2/sites-available/default
-And add the following text within the `<VirtualHost>` block:
+And add the following text within the :code:`<VirtualHost>` block:
.. code-block:: apache
@@ -47,89 +55,135 @@ And add the following text within the `<VirtualHost>` block:
ProxyPass /git/ !
ScriptAlias /git/ /usr/lib/git-core/git-http-backend/
- RewriteCond %{QUERY_STRING} service=git-receive-pack [OR]
- RewriteCond %{REQUEST_URI} /git-receive-pack$
- RewriteRule ^/git/ - [E=AUTHREQUIRED:yes]
+ # no authentication required at all - for testing purposes
+ SetEnv REMOTE_USER=git-allura
- <LocationMatch "^/git/">
- Order Deny,Allow
- Deny from env=AUTHREQUIRED
-
- AuthType Basic
- AuthName "Git Access"
- Require group committers
- Satisfy Any
- </LocationMatch>
-
-Then exit vim (`<esc> :wq`) and run:
+Then exit vim (:kbd:`<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/`
-(if using vagrant, use localhost:8088 on your host machine). If there is no output,
-that is fine (it'll list git heads once the repo has commits in it).
+To test that it's working, run: :command:`git ls-remote http://localhost/git/p/test/git/`
+(if using Vagrant, use :code:`localhost:8088` from your host machine).
+If there is no output, that is fine (it's an empty repo).
-Note that this has no authentication and is suitable for development only.
+.. warning::
-If you want to run a separate readonly git service, using the git protocol instead of http,
-run: `git daemon --reuseaddr --export-all --base-path=/srv/git /srv/git` It can
-be accessed at `git://localhost/p/test/git`
+ This configuration has no authentication and is suitable for development only.
-Depending on the hostname and ports you use, you may need to change the `scm.host.*`
-settings in `development.ini`.
+Now you will want to change the :samp:`scm.host.{*}.git`
+settings in :file:`development.ini`, so that the proper commands are shown to your visitors
+when they browse the code repo web pages.
+
+Read-only `git://`
+^^^^^^^^^^^^^^^^^^^^^^^^^
+If you want to run a separate readonly git service, using the git protocol instead of http,
+run: :program:`git daemon --reuseaddr --export-all --base-path=/srv/git /srv/git` It can
+be accessed at :code:`git://localhost/p/test/git`
Subversion
--------------
+These instructions will cover the recommended easiest way to run Subversion with Allura.
+For an overview of other options, see http://svnbook.red-bean.com/en/1.8/svn.serverconfig.choosing.html
+and subsequent chapters.
-Temp Notes:
---------------
+.. code-block:: bash
+
+ sudo mkdir /srv/svn
+ sudo chown allura:allura /srv/svn # or other user, as needed (e.g. "vagrant")
+
+ cat > /srv/svn/svnserve.conf <<EOF
+ [general]
+ realm = My Site SVN
+ # no authentication required at all - for testing purposes
+ anon-access = write
+ EOF
+
+ svnserve -d -r /srv/svn --log-file /tmp/svnserve.log --config-file /srv/svn/svnserve.conf
+
+Test by running: :command:`svn info svn://localhost/p/test/code/`. If you need to kill it,
+run :command:`killall svnserve` More info at http://svnbook.red-bean.com/en/1.8/svn.serverconfig.svnserve.html
+
+.. warning::
+
+ This configuration has no authentication and is suitable for development only.
+
+Now you will want to change the :samp:`scm.host.{*}.svn`
+settings in :file:`development.ini`, so that the proper commands are shown to your visitors
+when they browse the code repo web pages.
+
+Alternate Setup with HTTP
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To use SVN over HTTP, you will need to patch and compile an Apache module, so
+that all svn repos can by dynamically served.
+
+.. warning::
+
+ Not easy.
+
+.. code-block:: console
+
+ sudo aptitude install libapache2-svn
+
+Test accessing http://localhost/ (`localhost:8088` if using Vagrant).
+
+Now we'll configure Apache to serve a single project's repositories and make sure
+that works.
+
+.. code-block:: console
+
+ sudo vi /etc/apache2/mods-available/dav_svn.conf
+
+Uncomment and change to :code:`<Location /svn/p/test>`. Set
+:code:`SVNParentPath /srv/svn/p/test` Then run:
+
+.. code-block:: console
+
+ sudo service apache2 reload
+
+Test at http://localhost/svn/p/test/code/ (`localhost:8088` if using Vagrant)
+
+That configuration works only for the repositories in a single project. You must either
+create a new configuration for each project within Allura, or compile a patch
+to make `SVNParentPath` be recursive. The patch is at http://pastie.org/8550810
+and must be applied to the source of Subversion 1.7's mod_dav_svn and then
+recompiled and installed. (See http://subversion.tigris.org/issues/show_bug.cgi?id=3588
+for the request to include this patch in Subversion itself). Once that is working,
+you can modify :file:`dav_svn.conf` to look like:
+
+.. code-block:: apache
+
+ <Location /svn>
+ DAV svn
+ SVNParentPath /srv/svn
+ ...
+
+Then Apache SVN will serve repositories for all Allura project and subprojects.
+
+.. warning::
+
+ This configuration has no authentication and is suitable for development only.
+
+
+
+Configuring Git/SVN/Hg to use Allura auth via LDAP and ssh
+============================================================
+
+The following instructions will use a chroot, a custom FUSE driver, and LDAP.
+Once completed, an ssh-based configuration of Git, SVN, or Hg that has repos in
+the chroot directory will authenticate the users against LDAP and authorize via an Allura API.
+Allura will be configured to authenticate against LDAP as well.
+
+.. note::
+ The previous git & svn configuration instructions are not ssh-based, so will not work with this configuration.
+ You'll have to reconfigure git & svn to use ssh:// instead of http or svn protocols.
-STRUCTURE:
-separate authentication (ldap, allura) vs authorization (via allura API)
-different protocol (svn:// & git:// vs http)
- http://svnbook.red-bean.com/en/1.8/svn.serverconfig.choosing.html
- http://git-scm.com/book/ch4-1.html
-
-TODO:
- disable scm.host.https* in .ini?
- remove /home/vagrant/scm/ symlinks?
-
-SVN
- `sudo aptitude install libapache2-svn`
- test http://localhost:80/ (8088 if vagrant)
- `vi /etc/apache2/mods-available/dav_svn.conf`
- uncomment things
- Have to do a location & parentpath for each project, e.g "test" project
- <Location /svn/p/test>
- SVNParentPath /srv/svn/p/test
- todo: Auth* directives
- `service apache2 reload`
- test http://localhost:80/svn/p/test/code/ (8088 if vagrant)
- Now can change scm.host.(https|https_anon).svn to "http://localhost:80/svn$path/" (8088 if vagrant) for checkout instructions
- scm.host.(ro|rw) are intended for svn:// protocol
- make SVNParentPath recursive:
- http://subversion.tigris.org/issues/show_bug.cgi?id=3588
- https://sourceforge.net/p/allura/pastebin/517557273e5e837ec65122c1
- latest: https://trac.sdot.me/git/?p=srpmtree.git;a=blob_plain;f=subversion-recursive-parentpath.patch;hb=refs/heads/sog/subversion
- need to update it for trunk/1.8.x
- http://subversion.apache.org/docs/community-guide/general.html#patches
- http://subversion.apache.org/docs/community-guide/conventions.html
-
- svnserve shouldn't have parentpath restrictions, it allows complete access to a dir
- svnserve -d -r /srv/svn -R
- test: svn info svn://localhost/p/test/code/
- killall svnserve
- more info: http://svnbook.red-bean.com/en/1.8/svn.serverconfig.svnserve.html
-
-
-~~~~~~~
-
-The following instructions assume you are using a version of Ubuntu Linux with
+We assume you are using a version of Ubuntu with
support for schroot and debootstrap. We will use a chroot jail to allow users to
access their repositories via ssh.
@@ -138,9 +192,9 @@ Install a chroot environment
These instructions are based on the documentation in `Debootstrap Chroot`_. and `OpenLDAPServer`_.
-#. Install debootstrap schroot
+Install debootstrap and schroot: :program:`aptitude install debootstrap schroot`
-#. Append the following text to the file /etc/schroot/schroot.conf
+Append the following text to the file :file:`/etc/schroot/schroot.conf`
.. code-block:: ini
@@ -150,7 +204,7 @@ 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 :file:`/etc/schroot/scm` and populate it with some files:
.. code-block:: console
@@ -176,14 +230,14 @@ 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 :file:`/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
@@ -193,20 +247,20 @@ 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
@@ -228,7 +282,7 @@ In particular, you will need to answer the following questions (substitute your
Update the chroot ssh configuration
-------------------------------------------------
-* Update the file /var/chroot/scm/etc/ssh/sshd_config, changing the port directive:
+* Update the file :file:`/var/chroot/scm/etc/ssh/sshd_config`, changing the port directive:
.. code-block:: guess
@@ -238,40 +292,40 @@ 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
+ $ sudo ln -s /var/chroots/scm /srv/git
+ $ sudo ln -s /var/chroots/scm /srv/hg
+ $ sudo ln -s /var/chroots/scm /srv/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
[08/14] git commit: [#5424] specify syntax highlighting
Posted by tv...@apache.org.
[#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 <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
[07/14] git commit: [#5424] WIP: instructions for git & svn
Posted by tv...@apache.org.
[#5424] WIP: instructions for git & svn
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/de9c8180
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/de9c8180
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/de9c8180
Branch: refs/heads/master
Commit: de9c8180be92c539180032a23940524f02ea81f8
Parents: 1491189
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Thu Dec 12 18:19:14 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:34 2014 +0000
----------------------------------------------------------------------
Allura/docs/scm_host.rst | 102 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 101 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/de9c8180/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index e3379bf..090cd70 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -15,9 +15,109 @@
specific language governing permissions and limitations
under the License.
-SCM (Git, Mercurial, Subversion) Hosting Installation
+Git and Subversion Hosting Installation
==========================================================
+Allura can manage and display Git and SVN repositories, but it doesn't
+automatically run the git and svn services for you. Here we'll describe how
+to set up standard git and svn services to work with Allura, so that you can
+checkout and commit code with those repositories.
+
+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::
+
+ sudo a2enmod proxy rewrite
+ sudo vi /etc/apache2/sites-available/default
+ # and add the following within the <VirtualHost block
+
+ SetEnv GIT_PROJECT_ROOT /srv/git
+ SetEnv GIT_HTTP_EXPORT_ALL
+ ProxyPass /git/ !
+ ScriptAlias /git/ /usr/lib/git-core/git-http-backend/
+
+ RewriteCond %{QUERY_STRING} service=git-receive-pack [OR]
+ RewriteCond %{REQUEST_URI} /git-receive-pack$
+ RewriteRule ^/git/ - [E=AUTHREQUIRED:yes]
+
+ <LocationMatch "^/git/">
+ Order Deny,Allow
+ Deny from env=AUTHREQUIRED
+
+ AuthType Basic
+ AuthName "Git Access"
+ Require group committers
+ Satisfy Any
+ </LocationMatch>
+
+ sudo service apache2 reload
+
+To test that it's working, run: `git ls-remote http://localhost/git/p/test/git/`
+(if using vagrant, use localhost:8088 on your host machine). If there is no output,
+that is fine (it'll list git heads once the repo has commits in it).
+
+Note that this has no authentication and is suitable for development only.
+
+If you want to run a separate readonly git service, using the git protocol instead of http,
+run: `git daemon --reuseaddr --export-all --base-path=/srv/git /srv/git` It can
+be accessed at `git://localhost/p/test/git`
+
+Depending on the hostname and ports you use, you may need to change the `scm.host.*`
+settings in `development.ini`.
+
+
+Subversion
+--------------
+
+
+Temp Notes:
+--------------
+
+
+STRUCTURE:
+separate authentication (ldap, allura) vs authorization (via allura API)
+different protocol (svn:// & git:// vs http)
+ http://svnbook.red-bean.com/en/1.8/svn.serverconfig.choosing.html
+ http://git-scm.com/book/ch4-1.html
+
+TODO:
+ disable scm.host.https* in .ini?
+ remove /home/vagrant/scm/ symlinks?
+
+SVN
+ `sudo aptitude install libapache2-svn`
+ test http://localhost:80/ (8088 if vagrant)
+ `vi /etc/apache2/mods-available/dav_svn.conf`
+ uncomment things
+ Have to do a location & parentpath for each project, e.g "test" project
+ <Location /svn/p/test>
+ SVNParentPath /srv/svn/p/test
+ todo: Auth* directives
+ `service apache2 reload`
+ test http://localhost:80/svn/p/test/code/ (8088 if vagrant)
+ Now can change scm.host.(https|https_anon).svn to "http://localhost:80/svn$path/" (8088 if vagrant) for checkout instructions
+ scm.host.(ro|rw) are intended for svn:// protocol
+ make SVNParentPath recursive:
+ http://subversion.tigris.org/issues/show_bug.cgi?id=3588
+ https://sourceforge.net/p/allura/pastebin/517557273e5e837ec65122c1
+ latest: https://trac.sdot.me/git/?p=srpmtree.git;a=blob_plain;f=subversion-recursive-parentpath.patch;hb=refs/heads/sog/subversion
+ need to update it for trunk/1.8.x
+ http://subversion.apache.org/docs/community-guide/general.html#patches
+ http://subversion.apache.org/docs/community-guide/conventions.html
+
+ svnserve shouldn't have parentpath restrictions, it allows complete access to a dir
+ svnserve -d -r /srv/svn -R
+ test: svn info svn://localhost/p/test/code/
+ killall svnserve
+ more info: http://svnbook.red-bean.com/en/1.8/svn.serverconfig.svnserve.html
+
+
+~~~~~~~
+
The following instructions assume you are using a version of Ubuntu Linux with
support for schroot and debootstrap. We will use a chroot jail to allow users to
access their repositories via ssh.
[04/14] git commit: [#5424] fix rst syntax
Posted by tv...@apache.org.
[#5424] fix rst syntax
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/a8cca912
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/a8cca912
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/a8cca912
Branch: refs/heads/master
Commit: a8cca912ef57c9c3cae7b607856e0420b5b2825f
Parents: 81cf8e4
Author: Dave Brondsema <db...@slashdotmedia.com>
Authored: Tue Nov 19 17:43:59 2013 -0500
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:33 2014 +0000
----------------------------------------------------------------------
Allura/docs/administration.rst | 2 +-
Allura/docs/scm_host.rst | 18 +++++++++---------
2 files changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/a8cca912/Allura/docs/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/administration.rst b/Allura/docs/administration.rst
index eaf9387..19c2e53 100644
--- a/Allura/docs/administration.rst
+++ b/Allura/docs/administration.rst
@@ -80,7 +80,7 @@ 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::
> db.site_notification.insert({
... active: true,
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/a8cca912/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index fa61ef7..e3379bf 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -79,11 +79,11 @@ Configure OpenLDAP in the Chroot
$ 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::
# schroot -c scm -u root
-#. Run the setup script, following the prompts.
+#. Run the setup script, following the prompts::
(scm) # python /ldap-setup.py
@@ -111,37 +111,37 @@ 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::
$ 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::
$ 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::
# schroot -c scm -u root
(scm) # apt-get install python-fuse
-#. Create the SCM directories
+#. Create the SCM directories::
(scm) # mkdir /scm /scm-repo
-#. Mount the FUSE filesystem
+#. Mount the FUSE filesystem::
(scm) # python /accessfs.py /scm-repo -o allow_other -s -o root=/scm
-#. Start the SSH daemon
+#. Start the SSH daemon::
(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::
auth.method = ldap
[14/14] git commit: [#5424] Fix minor typos
Posted by tv...@apache.org.
[#5424] Fix minor typos
Signed-off-by: Tim Van Steenburgh <tv...@gmail.com>
Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/c67efb52
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/c67efb52
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/c67efb52
Branch: refs/heads/master
Commit: c67efb525633dc44a5548abc6b20547b43945cc2
Parents: 94ae6dd
Author: Tim Van Steenburgh <tv...@gmail.com>
Authored: Thu Jan 2 20:21:58 2014 +0000
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Thu Jan 2 20:22:35 2014 +0000
----------------------------------------------------------------------
Allura/docs/scm_host.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/c67efb52/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index f500703..0e11e8a 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -119,7 +119,7 @@ Alternate Setup with HTTP
^^^^^^^^^^^^^^^^^^^^^^^^^
To use SVN over HTTP, you will need to patch and compile an Apache module, so
-that all svn repos can by dynamically served.
+that all svn repos can be dynamically served.
.. warning::
@@ -162,7 +162,7 @@ you can modify :file:`dav_svn.conf` to look like:
SVNParentPath /srv/svn
...
-Then Apache SVN will serve repositories for all Allura project and subprojects.
+Then Apache SVN will serve repositories for all Allura projects and subprojects.
.. warning::
@@ -282,7 +282,7 @@ In particular, you will need to answer the following questions (substitute your
Update the chroot ssh configuration
-------------------------------------------------
-* Update the file :file:`/var/chroot/scm/etc/ssh/sshd_config`, changing the port directive:
+Update the file :file:`/var/chroot/scm/etc/ssh/sshd_config`, changing the port directive:
.. code-block:: guess