Trac - Revision history

Ppreddy@uab.edu: /* Create a Trac project */ rm repotype and repopath for initenv command

2010-12-08T20:30:25Z

Create a Trac project: rm repotype and repopath for initenv command

← Older revision		Revision as of 20:30, 8 December 2010
Line 54:		Line 54:
	:3. Create a trac environment for the above project. '''NOTE''': mention full paths when invoking '''trac-admin''' command		:3. Create a trac environment for the above project. '''NOTE''': mention full paths when invoking '''trac-admin''' command
	<pre>		<pre>
	trac-admin /Users/pnm/project-tmd/sites/myproject1 \		trac-admin /Users/pnm/project-tmd/sites/myproject1 initenv
	initenv \
	~~myproject1 \~~
	~~sqlite:db/trac.db \~~
	~~git~~
	~~/home/git/repositories/myproject1sourcecode.git \~~
	</pre>		</pre>
	:4. '''git''' corresponds to the ''repository type'', can be mercurial, svn etc. '''/home/git/repositories/myproject1sourcecode.git''' corresponds to the ''source code repository for your project''. This can be a local repository or mounted over a shared file system.

	==== Run Trac on Web Server ====		==== Run Trac on Web Server ====

Ppreddy@uab.edu: /* Install Trac */ delete plugin install steps, as this would further require editing of trac.ini, so keeping it simple for now

2010-12-08T20:29:12Z

Install Trac: delete plugin install steps, as this would further require editing of trac.ini, so keeping it simple for now

← Older revision		Revision as of 20:29, 8 December 2010
Line 38:		Line 38:
	<pre>easy_install Trac==dev</pre>		<pre>easy_install Trac==dev</pre>
	:2. This will install '''tracd''' and '''trac-admin''' to ''~/bin''		:2. This will install '''tracd''' and '''trac-admin''' to ''~/bin''
	~~:3. Install some basic plugins of interest like git, table of contents, python syntax highlighting etc~~
	~~<pre>easy_install http://trac-hacks.org/svn/gitplugin/0.12~~
	~~easy_install http://trac-hacks.org/svn/tocmacro/0.11~~
	~~easy_install pygments~~
	~~</pre>~~

	==== Create a Trac project ====		==== Create a Trac project ====

Ppreddy@uab.edu: add links to headers for Mac section

2010-12-06T17:35:20Z

add links to headers for Mac section

← Older revision		Revision as of 17:35, 6 December 2010
Line 19:		Line 19:

	=== Mac OS X ===		=== Mac OS X ===

			To set up a dev environment for Trac
			# [http://docs.uabgrid.uab.edu/wiki/Trac#Python Configure Python]
			# [http://docs.uabgrid.uab.edu/wiki/Trac#Install_Trac Install Trac] and related dependencies like Genshi
			# [http://docs.uabgrid.uab.edu/wiki/Trac#Create_a_Trac_Project Create Trac] instance
			# [http://docs.uabgrid.uab.edu/wiki/Trac#Run_Trac_On_Web_Server Deploy Trac] on a web server as a CGI executable
			# [http://docs.uabgrid.uab.edu/wiki/Trac#XAMPP Configure Apache] for Trac

	==== Python ====		==== Python ====

Ppreddy@uab.edu: indent numbered lists and preformatted text

2010-12-06T17:05:29Z

indent numbered lists and preformatted text

← Older revision		Revision as of 17:05, 6 December 2010
Line 28:		Line 28:
	==== Install Trac ====		==== Install Trac ====

	# EasyInstall the latest development version of Trac, which is currently, Trac-0.13dev-r10355. '''Note''': the latest dev version of Trac auto-installs its dependencies ie., Genshi, which was not a feature for Trac-0.12 and earlier installs <pre>easy_install Trac==dev</pre>		# EasyInstall the latest development version of Trac, which is currently, Trac-0.13dev-r10355. '''Note''': the latest dev version of Trac auto-installs its dependencies ie., Genshi, which was not a feature for Trac-0.12 and earlier installs
	# This will install '''tracd''' and '''trac-admin''' to ''~/bin''		<pre>easy_install Trac==dev</pre>
	# Install some basic plugins of interest like git, table of contents, python syntax highlighting etc		:2. This will install '''tracd''' and '''trac-admin''' to ''~/bin''
			:3. Install some basic plugins of interest like git, table of contents, python syntax highlighting etc
	<pre>easy_install http://trac-hacks.org/svn/gitplugin/0.12		<pre>easy_install http://trac-hacks.org/svn/gitplugin/0.12
	easy_install http://trac-hacks.org/svn/tocmacro/0.11		easy_install http://trac-hacks.org/svn/tocmacro/0.11
Line 39:		Line 40:

	NOTE: Directory structure mentioned below is just a recommendation. Can customize it to any desired location		NOTE: Directory structure mentioned below is just a recommendation. Can customize it to any desired location
	# Create a directory for trac meta data <pre>mkdir -p ~/project-tmd/sites</pre>		# Create a directory for trac meta data
	# Create a directory with project name. Replace ''<myproject>''		<pre>
			mkdir -p ~/project-tmd/sites
			</pre>
			:2. Create a directory with project name. Replace ''<myproject>''
	<pre>		<pre>
	project_name=<myproject>		project_name=<myproject>

Ppreddy@uab.edu: /* Developers */ mv setuptools to Python wiki and indent numbered lists

2010-12-06T17:01:06Z

Developers: mv setuptools to Python wiki and indent numbered lists

← Older revision		Revision as of 17:01, 6 December 2010
Line 22:		Line 22:
	==== Python ====		==== Python ====

	* ''Mac OS X comes with a pre-installation of Python, usually one or two years old'' [http://wiki.python.org/moin/MacPython/PythonDistributionsForMac]. Mac OS 10.6 (Snow Leopard) has 2.6.1 version of Python. This is adequate for developing Trac on Mac. Trac officially supports any Python version >=2.5 and <3.0 [http://trac.edgewall.org/wiki/0.13/TracInstall#MandatoryDependencies].		# ''Mac OS X comes with a pre-installation of Python, usually one or two years old'' [http://wiki.python.org/moin/MacPython/PythonDistributionsForMac]. Mac OS 10.6 (Snow Leopard) has 2.6.1 version of Python. This is adequate for developing Trac on Mac. Trac officially supports any Python version >=2.5 and <3.0 [http://trac.edgewall.org/wiki/0.13/TracInstall#MandatoryDependencies].
			# [http://docs.uabgrid.uab.edu/wiki/Python#Custom_Installation_of_Python_Packages_.28.24HOME.29 Configure Python path] for custom install of packages to your $HOME
	* [http://docs.uabgrid.uab.edu/wiki/Python#Custom_Installation_of_Python_Packages_.28.24HOME.29 Configure Python path] for custom install of packages to your $HOME		# [http://docs.uabgrid.uab.edu/wiki/Python#Setuptools_Installation Install setuptools]

	~~==== Install Setuptools ====~~

	* Download setuptools. Choose the appropriate version, ie., for Python-2.6, [http://~~pypi~~.~~python~~.~~org/packages/2~~.6/s/~~setuptools/setuptools-0.6c11-py2.6.egg~~#~~md5=bfa92100bd772d5a213eedd356d64086 download~~ setuptools~~-0.6c11-py2.6.egg~~]
	~~<pre>~~
	~~$ cd ~/Library/Python/2.6/site-packages/~~

	~~wget http://pypi.python.org/packages/2.6/s/setuptools/setuptools-0.6c11-py2.6.egg#md5=bfa92100bd772d5a213eedd356d64086~~
	~~</pre>~~

	* Make the setuptools package executable
	~~<pre>~~
	~~chmod +x setuptools-0.6c11-py2.6.egg~~
	~~</pre>~~

	* Run setuptools as a shell script. This will install '''easy_install''' to ''~/bin''
	~~<pre>~~
	~~sh setuptools-0.6c11-py2.6.egg~~
	~~</pre>~~

	==== Install Trac ====		==== Install Trac ====

	* EasyInstall the latest development version of Trac, which is currently, Trac-0.13dev-r10355. '''Note''': the latest dev version of Trac auto-installs its dependencies ie., Genshi, which was not a feature for Trac-0.12 and earlier installs.		# EasyInstall the latest development version of Trac, which is currently, Trac-0.13dev-r10355. '''Note''': the latest dev version of Trac auto-installs its dependencies ie., Genshi, which was not a feature for Trac-0.12 and earlier installs <pre>easy_install Trac==dev</pre>
	<pre>		# This will install '''tracd''' and '''trac-admin''' to ''~/bin''
	easy_install Trac==dev		# Install some basic plugins of interest like git, table of contents, python syntax highlighting etc
	</pre>		<pre>easy_install http://trac-hacks.org/svn/gitplugin/0.12

	* This will install '''tracd''' and '''trac-admin''' to ''~/bin''

	* Install some basic plugins of interest like git, table of contents, python syntax highlighting etc
	<pre>
	easy_install http://trac-hacks.org/svn/gitplugin/0.12
	easy_install http://trac-hacks.org/svn/tocmacro/0.11		easy_install http://trac-hacks.org/svn/tocmacro/0.11
	easy_install pygments		easy_install pygments
Line 64:		Line 39:

	NOTE: Directory structure mentioned below is just a recommendation. Can customize it to any desired location		NOTE: Directory structure mentioned below is just a recommendation. Can customize it to any desired location
	* Create a directory for trac meta data		# Create a directory for trac meta data <pre>mkdir -p ~/project-tmd/sites</pre>
	<pre>		# Create a directory with project name. Replace ''<myproject>''
	mkdir -p ~/project-tmd/sites
	</pre>

	* Create a directory with project name. Replace ''<myproject>''
	<pre>		<pre>
	project_name=<myproject>		project_name=<myproject>
Line 75:		Line 46:
	mkdir $project_name		mkdir $project_name
	</pre>		</pre>
			:3. Create a trac environment for the above project. '''NOTE''': mention full paths when invoking '''trac-admin''' command
	* Create a trac environment for the above project. '''NOTE''': mention full paths when invoking '''trac-admin''' command
	<pre>		<pre>
	trac-admin /Users/pnm/project-tmd/sites/myproject1 \		trac-admin /Users/pnm/project-tmd/sites/myproject1 \
Line 85:		Line 55:
	/home/git/repositories/myproject1sourcecode.git \		/home/git/repositories/myproject1sourcecode.git \
	</pre>		</pre>
			:4. '''git''' corresponds to the ''repository type'', can be mercurial, svn etc. '''/home/git/repositories/myproject1sourcecode.git''' corresponds to the ''source code repository for your project''. This can be a local repository or mounted over a shared file system.
	* '''git''' corresponds to the ''repository type'', can be mercurial, svn etc. '''/home/git/repositories/myproject1sourcecode.git''' corresponds to the ''source code repository for your project''. This can be a local repository or mounted over a shared file system.

	==== Run Trac on Web Server ====		==== Run Trac on Web Server ====

	* ''Trac provides various options for connecting to a "real" web server: CGI, FastCGI, mod_wsgi and mod_python'' [http://trac.edgewall.org/wiki/0.13/TracInstall#RunningTraconaWebServer]. Here we will look at running Trac as a simple CGI script. ''trac.cgi'' is a Python script which loads the appropriate Python code. This can be generated using the '''deploy''' option of ''trac-admin''.		# ''Trac provides various options for connecting to a "real" web server: CGI, FastCGI, mod_wsgi and mod_python'' [http://trac.edgewall.org/wiki/0.13/TracInstall#RunningTraconaWebServer]. Here we will look at running Trac as a simple CGI script. ''trac.cgi'' is a Python script which loads the appropriate Python code. This can be generated using the '''deploy''' option of ''trac-admin''.
	<pre>		<pre>
	trac-admin /Users/pnm/project-tmd/sites/myproject1 deploy /tmp/deploy		trac-admin /Users/pnm/project-tmd/sites/myproject1 deploy /tmp/deploy
Line 97:		Line 66:
	</pre>		</pre>

	* ''trac.cgi'' will be in the '''cgi-bin''' folder inside the given path. Make sure it is executable by your web server. This command also copies static resource files to a '''htdocs''' directory of a given destination.		:2. ''trac.cgi'' will be in the '''cgi-bin''' folder inside the given path. Make sure it is executable by your web server. This command also copies static resource files to a '''htdocs''' directory of a given destination.
	<pre>		<pre>
	$ cd ~/project-tmd		$ cd ~/project-tmd
Line 106:		Line 75:
	</pre>		</pre>

	* Copy ''trac.cgi'' to ~/Sites		:3. Copy ''trac.cgi'' to ~/Sites
	<pre>		<pre>
	cp ~/project-tmd/cgi-bin/trac.cgi ~/Sites/.		cp ~/project-tmd/cgi-bin/trac.cgi ~/Sites/.
Line 124:		Line 93:
	ScriptAlias /trac /Users/pnm/Sites/trac.cgi		ScriptAlias /trac /Users/pnm/Sites/trac.cgi
	</pre>		</pre>
	# Start xampp's apache, either through the xampp control or command line. '''NOTE''': xampp needs ''root'' permission to start apache, but will switch to the current user.		:3. Start xampp's apache, either through the xampp control or command line. '''NOTE''': xampp needs ''root'' permission to start apache, but will switch to the current user.
	<pre>		<pre>
	$ sudo /Applications/XAMPP/xamppfiles/bin/httpd -k start		$ sudo /Applications/XAMPP/xamppfiles/bin/httpd -k start
	</pre>		</pre>
	# Browsing to http://localhost/trac should bring up a list of trac projects created within the ~/project-tmd/sites directory (a link for each project). So, for the above created project (myproject1), the url will be http://localhost/trac/myproject1		:4. Browsing to http://localhost/trac should bring up a list of trac projects created within the ~/project-tmd/sites directory (a link for each project). So, for the above created project (myproject1), the url will be http://localhost/trac/myproject1

	== References ==		== References ==

Ppreddy@uab.edu: /* Install Trac */ add easy_install for git, toc, and pygments

2010-12-03T21:22:53Z

Install Trac: add easy_install for git, toc, and pygments

← Older revision		Revision as of 21:22, 3 December 2010
Line 53:		Line 53:

	* This will install '''tracd''' and '''trac-admin''' to ''~/bin''		* This will install '''tracd''' and '''trac-admin''' to ''~/bin''

			* Install some basic plugins of interest like git, table of contents, python syntax highlighting etc
			<pre>
			easy_install http://trac-hacks.org/svn/gitplugin/0.12
			easy_install http://trac-hacks.org/svn/tocmacro/0.11
			easy_install pygments
			</pre>

	==== Create a Trac project ====		==== Create a Trac project ====

Ppreddy@uab.edu: /* Developers */ add trac project create steps

2010-12-03T21:13:12Z

Developers: add trac project create steps

@@ Line 22: / Line 22: @@
 ==== Python ====
-''Mac OS X comes with a pre-installation of Python, usually one or two years old'' [http://wiki.python.org/moin/MacPython/PythonDistributionsForMac]. Mac OS 10.6 (Snow Leopard) has 2.6.1 version of Python. This is adequate for developing Trac on Mac. Trac officially supports any Python version >=2.5 and <3.0 [http://trac.edgewall.org/wiki/0.13/TracInstall#MandatoryDependencies].
+* ''Mac OS X comes with a pre-installation of Python, usually one or two years old'' [http://wiki.python.org/moin/MacPython/PythonDistributionsForMac]. Mac OS 10.6 (Snow Leopard) has 2.6.1 version of Python. This is adequate for developing Trac on Mac. Trac officially supports any Python version >=2.5 and <3.0 [http://trac.edgewall.org/wiki/0.13/TracInstall#MandatoryDependencies].
-To have a complete development environment in your $HOME, python path must be configured properly. Before proceeding further, configure your '''PYTHONPATH''' to install python eggs in your $HOME instead of the system python path ie., /System/Library/Frameworks/Python.Framework or /Library/Frameworks/Python.FrameworkFor more details on Python for Macintosh  [http://docs.uabgrid.uab.edu/wiki/Python see here].
+* [http://docs.uabgrid.uab.edu/wiki/Python#Custom_Installation_of_Python_Packages_.28.24HOME.29 Configure Python path] for custom install of packages to your $HOME
 ==== XAMPP ====
 # [http://docs.uabgrid.uab.edu/wiki/XAMPP Install and configure XAMPP for Mac]
 # Edit ''/Applications/XAMPP/etc/httpd.conf'' with the following
-# Edit ''/Applications/XAMPP/etc/httpd.conf'' with the following <pre><Location /trac>
+<pre>
          SetEnv TRAC_ENV_PARENT_DIR /Users/pnm/project-tmd/sites
          SetEnv PYTHONPATH /Users/pnm/Library/Python/2.6/site-packages
@@ Line 37: / Line 116: @@
 ScriptAlias /trac /Users/pnm/Sites/trac.cgi
- </pre>
+</pre>
 == References ==

Ppreddy@uab.edu: /* Developers */ add python info for mac

2010-12-03T18:01:09Z

Developers: add python info for mac

← Older revision		Revision as of 18:01, 3 December 2010
Line 17:		Line 17:

	NOTE: Though there may be any number of ways to set up an AMP stack, recommended here is one easy way which has cross-platform capability ie., [[XAMPP]] developed by Apache Friends.		NOTE: Though there may be any number of ways to set up an AMP stack, recommended here is one easy way which has cross-platform capability ie., [[XAMPP]] developed by Apache Friends.

			=== Mac OS X ===

			==== Python ====

			''Mac OS X comes with a pre-installation of Python, usually one or two years old'' [http://wiki.python.org/moin/MacPython/PythonDistributionsForMac]. Mac OS 10.6 (Snow Leopard) has 2.6.1 version of Python. This is adequate for developing Trac on Mac. Trac officially supports any Python version >=2.5 and <3.0 [http://trac.edgewall.org/wiki/0.13/TracInstall#MandatoryDependencies].

			To have a complete development environment in your $HOME, python path must be configured properly. Before proceeding further, configure your '''PYTHONPATH''' to install python eggs in your $HOME instead of the system python path ie., /System/Library/Frameworks/Python.Framework or /Library/Frameworks/Python.FrameworkFor more details on Python for Macintosh [http://docs.uabgrid.uab.edu/wiki/Python see here].

			==== XAMPP ====

			# [http://docs.uabgrid.uab.edu/wiki/XAMPP Install and configure XAMPP for Mac]
			#
			# Edit ''/Applications/XAMPP/etc/httpd.conf'' with the following <pre><Location /trac>
			SetEnv TRAC_ENV_PARENT_DIR /Users/pnm/project-tmd/sites
			SetEnv PYTHONPATH /Users/pnm/Library/Python/2.6/site-packages
			SetEnv PYTHON_EGG_CACHE /Users/pnm/Library/Python/2.6/site-packages
			</Location>

			ScriptAlias /trac /Users/pnm/Sites/trac.cgi
			</pre>

	== References ==		== References ==

Ppreddy@uab.edu: /* Developers */ change sentence formation

2010-12-02T20:08:15Z

Developers: change sentence formation

← Older revision		Revision as of 20:08, 2 December 2010
Line 12:		Line 12:
	== Developers ==		== Developers ==

	For developers, interested in customizing Trac (theme, plugins~~, or plain suffering from a hack-mania~~ etc), setting up a development environment in one's own space without much fuss and moving parts, is of primary concern. This brings down to two essential components for developing for Trac,		For developers, interested in customizing Trac (theme, plugins etc), setting up a development environment in one's own space without much fuss and moving parts, is of primary concern. This brings down to two essential components for developing for Trac,
	# [[Python]]		# [[Python]]
	# [[XAMPP]] (Apache, MySQL, PHP, Perl) stack.		# [[XAMPP]] (Apache, MySQL, PHP, Perl) stack.

Ppreddy@uab.edu: /* End Users */ point to help links to end users

2010-11-30T23:39:53Z

End Users: point to help links to end users

← Older revision		Revision as of 23:39, 30 November 2010
Line 6:		Line 6:
	== End Users ==		== End Users ==

	For end users interested in using Trac as a wiki, ticket/bug reporting tool (TBD, a landing page...)		For end users interested in using Trac as a wiki, ticket/bug reporting tool send an email to...

			Coming soon, a self servicing web interface for provisioning a trac instance(TBD, a landing page...)

	== Developers ==		== Developers ==