Setting up trac wiki: Difference between revisions

Revision as of 09:28, 31 December 2008

Initial Setup

This document is based on alpine-1.7.29 and should also be compatible with newer version of alpine.

Follow Installing Alpine instructions on how to setup alpine.

Installing programs

 apk_add trac
 apk_add sqlite

 apk_add python
 apk_add python-dev
 apk_add setuptools

Note: Above packages might end up as dependencies to trac (mentioning them as a reminder for now).

General notes on this tutorial

In this tutorial we use these settings. These values will re-appear in various places in the upcoming example.
You can use whatever settings you like.

Path to project:	/root/myproject
Username:	tractester
Realm:	mycompany.com
Password:	secret
Password file:	/root/myproject/users.realm

Installing Trac

 easy_install trac

Creating a Project Environment

Now lets initiate the environment

 trac-admin /root/myproject initenv

Enter some project name when prompted
Leave svn-path empty (se note below)

Important: When prompted about svn, don't enter any value!
alpine-1.7.29 is missing svn support for trac (standard svn support works though).

Configuring Authentication/Security

Create password-file

You need to create a password file containing this information

 echo -e "tractester:mycompany.com:secret\c" | md5sum - >> /root/myproject/users.htdigest

Now you need to edit the passwordfile '/root/myproject/users.htdigest' and append the username and realm in plaintext.

 tractester:mycompany.com:65f5e135c5ed43b1a1340a3188062fd6

Note: Note that you need to remove the "-" and whitespaces at the end of the row!

Admin-rights

Next is to give admin-rights to your 'tractester' account

 trac-admin /root/myproject permission add tractester TRAC_ADMIN

Running/Testing the Standalone Server

Lets test if your password-file and other configurations worked as they are supposed to.
In case something is broken, this test would give you a hint on what's wrong.

 tracd --port 8000 --auth=*,/root/myproject/users.htdigest,mycompany.com /root/myproject

Note: You could use a WebBrowser to see the 'trac' page while above process is running.

Configuration/Startup

Edit '/etc/conf.d/tracd' and configure your variables

TRACD_PORT="80"
TRACD_OPTS="--auth=*,/root/myproject/users.htdigest,mycompany.com /root/myproject"
TRACD_USER="root"
TRACD_GROUP="root"

Note: Above user/group should probably not be 'root'.

Configuration/Startup

Now you could start customizing your trac by editing '/root/myproject/conf/trac.ini'.

Startup

Now it's time to fire up your trac.

 /etc/init.d/tracd start

Other

It might be wise to configure your tracd to autostart at next reboot

rc_add -vk tracd

It might also be wise to make sure you don't lose your '/root/myproject' files when your alpine is rebooted.
This could be done by adding '/root/myproject' to your apkovl

 lbu_include /root/myproject

or you could mount a disk on '/root/myproject'.

Note: And it would probably be wise to use other settings/filenames/folders than in this tutorial.

@@ Line 1: / Line 1: @@
 == Initial Setup ==
-This document is based on '''alpine-1.7.29''' and should also be compatible with newer version of Alpine.
+This document is based on [http://distrib-coffee.ipsl.jussieu.fr/pub/linux/alpine/alpine/v1.7/iso/alpine-1.7.29-i386.iso alpine-1.7.29] and should also be compatible with newer version of [http://wiki.alpinelinux.org/w/index.php?title=Main_Page alpine].
-'''''Note:''' Follow [http://wiki.alpinelinux.org/w/index.php?title=Installing_Alpine Installing Alpine] instructions on how to setup Alpine''
+Follow [http://wiki.alpinelinux.org/w/index.php?title=Installing_Alpine Installing Alpine] instructions on how to setup [http://wiki.alpinelinux.org/w/index.php?title=Main_Page alpine].
 == Installing programs ==
    apk_add trac
+  apk_add sqlite
    apk_add python
    apk_add python-dev
    apk_add setuptools
-  apk_add sqlite
+'''Note:''' Above packages might end up as dependencies to trac (mentioning them as a reminder for now).
-'''''Note:''' Above packages might end up as dependencies to trac (mentioning them as a reminder for now)''
+== General notes on this tutorial ==
+In this tutorial we use these settings. These values will re-appear in various places in the upcoming example.<BR>
+You can use whatever settings you like.
+{| style="width: 450px;  background-color: #f8f8f8; border: 1px #ccc solid;"
+|'''Path to project:'''
+|/root/myproject
+|-
+|'''Username:'''
+|tractester
+|-
+|'''Realm:'''
+|mycompany.com
+|-
+|'''Password:'''
+|secret
+|-
+|'''Password file:'''
+|/root/myproject/users.realm
+|}
 == Installing Trac ==
@@ Line 17: / Line 37: @@
 == Creating a Project Environment ==
-In this tutorial we use these settings
-* '''Path to project:''' /root/myproject
 Now lets initiate the environment
    trac-admin /root/myproject initenv
 * Enter some project name when prompted
+* Leave svn-path '''empty''' (se note below)
 '''Important:''' When prompted about svn, don't enter any value!<BR>
-Alpine-1.7.29 is missing svn support for trac (standard svn support works though).
+[http://distrib-coffee.ipsl.jussieu.fr/pub/linux/alpine/alpine/v1.7/iso/alpine-1.7.29-i386.iso alpine-1.7.29] is missing svn support for trac (standard svn support works though).
 == Configuring Authentication/Security ==
-=== In this example... ===
-Lets assume you want to use
-* '''Username:''' tractester
-* '''Realm:''' mycompany.com
-* '''Password:''' secret
 === Create password-file ===
 You need to create a password file containing this information
    echo -e "tractester:mycompany.com:secret\c" | md5sum - >> /root/myproject/users.htdigest
-Now you need to edit the passwordfile ''/root/myproject/users.htdigest'' and app the username and realm in plaintext.
+Now you need to edit the passwordfile '/root/myproject/users.htdigest' and append the username and realm in plaintext.
    tractester:mycompany.com:65f5e135c5ed43b1a1340a3188062fd6
-'''''Important:''' Note that you need to remove the "-" and whitespaces at the end of the row!''
+'''Note:''' Note that you need to remove the "-" and whitespaces at the end of the row!
 === Admin-rights ===
@@ Line 45: / Line 57: @@
 == Running/Testing the Standalone Server ==
-For some reason it seems we need to manually test ''tracd'' before using the init.d script.<BR>
+Lets test if your password-file and other configurations worked as they are supposed to.<BR>
-Might be some files are created at first run - that's needed by the init.d script (not sure about this though).
+In case something is broken, this test would give you a hint on what's wrong.
    tracd --port 8000 --auth=*,/root/myproject/users.htdigest,mycompany.com /root/myproject
-If all looks ok you can proceed with this wiki.
+'''Note:''' You could use a WebBrowser to see the 'trac' page while above process is running.
 == Configuration/Startup ==
-Edit ''/etc/conf.d/tracd'' and configure your variables
+Edit '/etc/conf.d/tracd' and configure your variables
   TRACD_PORT="80"
   TRACD_OPTS="--auth=*,/root/myproject/users.htdigest,mycompany.com /root/myproject"
@@ Line 57: / Line 69: @@
   TRACD_GROUP="root"
-'''''Note:''' Above user/group should probably not be 'root'. Changing this later on''
+'''Note:''' Above user/group should probably not be 'root'.
 == Configuration/Startup ==
 Now you could start customizing your trac by editing '/root/myproject/conf/trac.ini'.
+== Startup ==
+Now it's time to fire up your trac.
+  /etc/init.d/tracd start
+== Other ==
+It might be wise to configure your tracd to autostart at next reboot
+ rc_add -vk tracd
+It might also be wise to make sure you don't lose your '/root/myproject' files when your [http://wiki.alpinelinux.org/w/index.php?title=Main_Page alpine] is rebooted.<BR>
+This could be done by adding '/root/myproject' to your apkovl
+  lbu_include /root/myproject
+or you could mount a disk on '/root/myproject'.
+'''Note:''' And it would probably be wise to use other settings/filenames/folders than in this tutorial.