Trac: Difference between revisions

Latest revision as of 12:48, 10 November 2023

Trac is an enhanced wiki and issue tracking system for software development projects. Trac uses a minimalistic approach to web-based software project management. Our mission is to help developers write great software while staying out of the way. Trac should impose as little as possible on a team's established development process and policies.

Installation

Install the trac^AUR package. Configuration is done on a per-environment basis. See below on how to create an environment. Detailed instructions can be found at https://trac.edgewall.org/wiki/TracGuide.

Configuration

Create and initialize an environment

Initialize an environment

# cd /srv/
# mkdir tracenv
# trac-admin /srv/tracenv initenv

The environment configuration can be found at /srv/tracenv/conf/trac.ini.

Configure the systemd unit

Edit tracd.service using a drop-in file point to your new environment. The ExecStart entry should look something like this:

ExecStart=/usr/bin/tracd -b localhost -p 8080 /srv/tracenv

Webinterface

Start/enable the service and you can view the web interface at http://localhost:8080 using a web browser.

Trac user

It is a good idea to create a dedicated user for the trac service. Once that user is created, you can create the environment using that user:

# cd /srv/
# mkdir tracenv
# chown trac:trac tracenv
[trac]$ trac-admin /srv/tracenv initenv

Extend the unit file to make sure it is started as the trac user:

[Service]
User=trac
Group=trac

Users and permissions within trac

(This section refers to creating users within the trac environment rather than GNU/Linux users.)

Next, you will want to add users and give permissions to those users. To add users, see https://trac.edgewall.org/wiki/TracStandalone#UsingAuthentication (you will have to change your .service file to refer to the authentication mechanism you choose). To grant permissions to users, run the following on the trac server:

# trac-admin /srv/tracenv permission add <username> TRAC_ADMIN

@@ Line 3: / Line 3: @@
 [[ja:Trac]]
 [[zh-hans:Trac]]
-From the [http://trac.edgewall.org project web page]:
+From the [https://trac.edgewall.org project web page]:
 :Trac is an enhanced wiki and issue tracking system for software development projects. Trac uses a minimalistic approach to web-based software project management. Our mission is to help developers write great software while staying out of the way. Trac should impose as little as possible on a team's established development process and policies.
 == Installation ==
-[[Install]] the {{AUR|trac}} package. Configuration is done on a per-environment basis. See below on how to create an environment. Detailed instructions can be found at http://trac.edgewall.org/wiki/TracGuide.
+[[Install]] the {{AUR|trac}} package. Configuration is done on a per-environment basis. See below on how to create an environment. Detailed instructions can be found at https://trac.edgewall.org/wiki/TracGuide.
+== Configuration ==
+=== Create and initialize an environment ===
-== Getting Started Quickly ==
-=== Create and Initialize an Environment ===
 Initialize an environment
-  # cd /srv/;
+  # cd /srv/
-  # mkdir tracenv;
+  # mkdir tracenv
-  # trac-admin /srv/tracenv initenv;
+  # trac-admin /srv/tracenv initenv
 The environment configuration can be found at {{ic|/srv/tracenv/conf/trac.ini}}.
-=== Configure the systemd Service File ===
+=== Configure the systemd unit ===
-A default service file is located at {{ic|/usr/lib/systemd/system/tracd.service}}. Copy this file to {{ic|/etc/systemd/system/tracd.service}}, and edit it to point to your new environment. The {{ic|ExecStart}} entry should look something like this:
+[[Edit]] {{ic|tracd.service}} using a [[drop-in file]]  point to your new environment. The {{ic|ExecStart}} entry should look something like this:
   ExecStart=/usr/bin/tracd -b localhost -p 8080 /srv/tracenv
-=== Viewing Webserver ===
+=== Webinterface ===
-After [[Start]]ing (and optionally [[enabling]]) the service (or running {{ic|/usr/bin/tracd}} directly), you can view the web interface at {{ic|http://localhost:8080}} using a web browser.
-== Next Steps ==
+[[Start/enable]] the service and you can view the web interface at {{ic|http://localhost:8080}} using a web browser.
-=== Trac User ===
+=== Trac user ===
-It is a good idea to create a [[user]] specially for the trac service. Once that user is created, you can create the environment using that user:
+It is a good idea to create a dedicated [[user]] for the trac service. Once that user is created, you can create the environment using that user:
-  # cd /srv/;
+  # cd /srv/
-  # mkdir tracenv;
+  # mkdir tracenv
-  # chown trac:trac tracenv;
+  # chown trac:trac tracenv
-  # sudo -u trac trac-admin /srv/tracenv initenv;
+  [trac]$ trac-admin /srv/tracenv initenv
-Add the following to the systemd unit file to make sure it is started as the {{ic|trac}} user:
+[[Extend the unit]] file to make sure it is started as the {{ic|trac}} user:
   [Service]
@@ Line 46: / Line 47: @@
   Group=trac
-=== Users and Permissions within Trac===
+=== Users and permissions within trac ===
 (This section refers to creating users within the trac environment rather than GNU/Linux users.)
-Next, you'll want to add users and give permissions to those users. To add users, see http://trac.edgewall.org/wiki/TracStandalone#UsingAuthentication (you will have to change your {{ic|.service}} file to refer to the authentication mechanism you choose). To grant permissions to users, run the following on the trac server:
+Next, you will want to add users and give permissions to those users. To add users, see https://trac.edgewall.org/wiki/TracStandalone#UsingAuthentication (you will have to change your {{ic|.service}} file to refer to the authentication mechanism you choose). To grant permissions to users, run the following on the trac server:
   # trac-admin /srv/tracenv permission add <username> TRAC_ADMIN