Trac:修订间差异
(→安裝) |
|||
(未显示同一用户的175个中间版本) | |||
第2行: | 第2行: | ||
== 簡介 == | == 簡介 == | ||
=== 優點 === | === 優點 === | ||
* 簡單,專 | |||
* 簡單,專 注 在事情的記錄上,而不是限制行為上。 | |||
=== 缺點 === | === 缺點 === | ||
* | |||
* <del> 目前 的版本(1.4) 還是不支援Python 3 ,但1.5已經在開發了。</del>目前支援[[Python]] 3的1.6版已經出了 。 | |||
== 安裝 == | == 安裝 == | ||
=== 目前有安裝的 === | |||
我是將[[Python]]裝在<code>service-trac</code>這個使用者的[[pyenv]]裡面(權限會是<code>service-trac:service-trac</code>)。在裝完Python後,用<code>pip</code>安裝以下套件: | |||
<syntaxhighlight lang="bash"> | |||
sudo apt install -y libmysqlclient-dev | |||
pip install mysqlclient pytz PyMySQL Pygments Trac | |||
</syntaxhighlight> | |||
使用[[MariaDB]]時需要把改變dependency: | |||
<syntaxhighlight lang="bash"> | |||
sudo apt install -y libmariadb-dev | |||
pip install mysqlclient pytz PyMySQL Pygments Trac | |||
</syntaxhighlight> | |||
使用[[MySQL]]或是[[MariaDB]]作為後端資料庫時,建議用utf8mb4作為基礎,這樣資料庫可以存所有範圍的Unicode字元<ref>{{Cite web|url=https://trac.edgewall.org/wiki/MySqlDb|title=MySqlDb – The Trac Project|accessdate=2018-03-01}}</ref>,另外建立獨立的使用者供Trac使用: | |||
<syntaxhighlight lang="sql"> | |||
CREATE DATABASE trac DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin; | |||
CREATE USER `trac`@`127.0.0.1` IDENTIFIED BY 'password_here'; | |||
GRANT ALL ON trac.* TO `trac`@`127.0.0.1`; | |||
</syntaxhighlight> | |||
接下來就可以產生環境: | |||
<syntaxhighlight lang="bash"> | |||
cd ~; trac-admin trac initenv | |||
</syntaxhighlight> | |||
這邊在安裝Trac時的資料庫連線設定會是<code>mysql://trac:password_here@127.0.0.1/trac</code>(需要自己修改對應欄位)。 | |||
在安裝套件時,軟體本體常常會放在[[Subversion]]的伺服器內,在透過<code>pip</code>或是<code>easy_install</code>時會呼叫Subversion,所以會需要安裝對應的軟體: | |||
<syntaxhighlight lang="bash"> | |||
sudo apt install -y subversion | |||
</syntaxhighlight> | |||
另外要建立目錄(放附件之類的東西): | |||
<syntaxhighlight lang="bash"> | |||
cd ~; mkdir trac/files | |||
</syntaxhighlight> | |||
=== FastCGI === | |||
然後是Trac的[[FastCGI]]檔案,放在Trac的project目錄下,並且用<code>chmod 755 trac.fcgi</code>改成可執行,這邊的<code>num</code>是指跑daemon的數量,通常可以設定成與CPU或是vCPU數量相同的數字: | |||
<syntaxhighlight lang="python"> | |||
#!/usr/bin/env python3 | |||
import os | |||
from trac.web.main import dispatch_request | |||
import trac.web._fcgi | |||
num = 4 | |||
sockaddr = os.path.expanduser('~') + '/trac/trac.sock' | |||
os.environ['TRAC_ENV'] = os.path.dirname(__file__) | |||
fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request, bindAddress = sockaddr, umask = 7) | |||
for _ in range(num - 1): | |||
if 0 == os.fork(): | |||
break | |||
fcgiserv.run() | |||
</syntaxhighlight> | |||
另外使用userland [[systemd]](需要先啟用這個設定),讓Trac在開機時將FastCGI daemon跑起來,這個檔案放在<code>~/.config/systemd/user/trac-fcgi.service</code>: | |||
<syntaxhighlight lang="ini"> | |||
[Unit] | |||
Description=Trac FastCGI daemon | |||
After=remote-fs.target | |||
[Service] | |||
ExecStart=/bin/bash -l -c "exec ~/trac/trac.fcgi" | |||
Type=simple | |||
[Install] | |||
WantedBy=default.target | |||
</syntaxhighlight> | |||
然後讓systemd重新讀取,並且設定為開機啟動,最後手動先跑起來(或是重開機): | |||
<syntaxhighlight lang="bash"> | |||
systemctl --user daemon-reload | |||
systemctl --user enable --now trac-fcgi.service | |||
</syntaxhighlight> | |||
另外要讓[[nginx]]可以存取<code>/var/run/trac/trac.sock</code>,然後完全重跑nginx: | |||
<syntaxhighlight lang="bash"> | |||
sudo useradd -G service-trac www-data; sudo service nginx restart | |||
</syntaxhighlight> | |||
== 套件 == | |||
=== 目前有安裝的 套件 === | |||
除了基本安裝外,還會安裝這些套件: | 除了基本安裝外,還會安裝這些套件: | ||
* [https://trac-hacks.org/wiki/AccountManagerPlugin AccountManagerPlugin – Trac Hacks - Plugins Macros etc.] | |||
** 可以吃HTML Form Login,而不侷限在HTTP authentication。 | |||
* [https://trac-hacks.org/wiki/BlueFlatTheme BlueFlatTheme – Trac Hacks - Plugins Macros etc.] | |||
** 目前Trac上少數支援Responsive Design的Theme,需要使用ThemeEnginePlugin安裝並啟用。 | |||
* [https://trac-hacks.org/wiki/DuplicateTicketSearchPlugin DuplicateTicketSearchPlugin – Trac Hacks - Plugins Macros etc.] | |||
** 在開新票時可以拉出有哪些是可能重複的票(尤其是已經關掉的票)。 | |||
* [https://trac-hacks.org/wiki/GraphvizPlugin GraphvizPlugin – Trac Hacks - Plugins Macros etc.] | * [https://trac-hacks.org/wiki/GraphvizPlugin GraphvizPlugin – Trac Hacks - Plugins Macros etc.] | ||
** Graphviz可以拿來畫各類圖,我自己最常用的是Dot圖。 | ** Graphviz可以拿來畫各類圖,我自己最常用的是Dot圖。 | ||
* [https://trac-hacks.org/wiki/SlackIntegration SlackIntegration – Trac Hacks - Plugins Macros etc.] | |||
** 可以把變更丟到Slack上,這邊要注意的是套件本身沒有把相依性做好,需要自己安裝<code>requests</code>套件。在Trac 1.6上面因為Python 3的原因會有問題,可以裝[https://github.com/gslin/trac-slack-plugin 我修的版本]。 | |||
* [https://trac-hacks.org/wiki/SubticketsPlugin SubticketsPlugin – Trac Hacks - Plugins Macros etc.] | * [https://trac-hacks.org/wiki/SubticketsPlugin SubticketsPlugin – Trac Hacks - Plugins Macros etc.] | ||
** 子母票的延伸套件,基本上是必備項目。 | ** 子母票的延伸套件,基本上是必備項目 。原版的程式安裝在MySQL 8.0的環境下會出問題(也不支援Trac 1.6),可以用[https://github.com/gslin/trac-subtickets-plugin 我修的版本]。 | ||
* [https://trac-hacks.org/wiki/ThemeEnginePlugin ThemeEnginePlugin – Trac Hacks - Plugins Macros etc.] | |||
** Theme的套件管理工具,配合BlueFlatTheme用的 。 | |||
* [https://trac-hacks.org/wiki/TracCronPlugin TracCronPlugin – Trac Hacks - Plugins Macros etc.] | * [https://trac-hacks.org/wiki/TracCronPlugin TracCronPlugin – Trac Hacks - Plugins Macros etc.] | ||
** 定時跑任務,但其實沒很好用... 目前主要是拿來每天寄信通知有哪些票過期。 | ** 定時跑任務,但其實沒很好用... 目前主要是拿來每天寄信通知有哪些票過期。 | ||
第24行: | 第136行: | ||
** 讓使用者可以透過API操作Trac。 | ** 讓使用者可以透過API操作Trac。 | ||
== | 目前Trac 1.4版的安裝方式是: | ||
以前會安裝,但現在因為自己用而沒有裝上: | |||
<syntaxhighlight lang="bash"> | |||
#!/bin/bash | |||
pip install -U TracCronPlugin | |||
pip install -U genshi | |||
pip install -U git+https://github.com/gslin/trac-subtickets-plugin.git | |||
pip install -U git+https://github.com/gslin/trac-slack-plugin.git | |||
pip install -U requests | |||
pip install -U svn+https://trac-hacks.org/svn/accountmanagerplugin/trunk/ | |||
pip install -U svn+https://trac-hacks.org/svn/duplicateticketsearchplugin/trunk/ | |||
pip install -U svn+https://trac-hacks.org/svn/graphvizplugin/branches/1.2/ | |||
pip install -U svn+https://trac-hacks.org/svn/tracdragdropplugin/0.12/ | |||
pip install -U svn+https://trac-hacks.org/svn/tracwysiwygplugin/0.12/ | |||
pip install -U svn+https://trac-hacks.org/svn/xmlrpcplugin/trunk/ | |||
</syntaxhighlight> | |||
對應的<code>requirements.txt</code>是: | |||
<syntaxhighlight lang="text"> | |||
-e git+https://github.com/gslin/trac-subtickets-plugin.git | |||
-e git+https://github.com/gslin/trac-slack-plugin.git | |||
-e svn+https://trac-hacks.org/svn/accountmanagerplugin/trunk/ | |||
-e svn+https://trac-hacks.org/svn/duplicateticketsearchplugin/trunk/ | |||
-e svn+https://trac-hacks.org/svn/graphvizplugin/branches/1.2/ | |||
-e svn+https://trac-hacks.org/svn/tracdragdropplugin/0.12/ | |||
-e svn+https://trac-hacks.org/svn/tracwysiwygplugin/0.12/ | |||
-e svn+https://trac-hacks.org/svn/xmlrpcplugin/trunk/ | |||
TracCronPlugin | |||
genshi | |||
requests | |||
</syntaxhighlight> | |||
可 以 用<code>pip install -r requirements.txt</code> 安裝 。 | |||
=== 曾經裝過 的 套件 === | |||
以前會安裝,但現在因為自己用而沒有裝上 (沒有需求或是不想裝) : | |||
* [https://trac-hacks.org/wiki/AutocompleteUsersPlugin AutocompleteUsersPlugin – Trac Hacks - Plugins Macros etc.] | |||
** 讓使用者帳號名稱可以autocomplete,在Cc欄位與Owner欄位會很好用。 | |||
* [https://trac-hacks.org/wiki/DefaultCcPlugin DefaultCcPlugin – Trac Hacks - Plugins Macros etc.] | * [https://trac-hacks.org/wiki/DefaultCcPlugin DefaultCcPlugin – Trac Hacks - Plugins Macros etc.] | ||
** 針對不同的Component自動加上Cc列表。 | ** 針對不同的Component自動加上Cc列表。 | ||
** 對於企業內還蠻有用的。像是專案可以開<code>Proj.</code>開頭的Component,而組織可以開<code>Org.</code>開頭的Component,這些類型可以設定對應的Cc列表。 | ** 對於企業內還蠻有用的。像是專案可以開<code>Proj.</code>開頭的Component,而組織可以開<code>Org.</code>開頭的Component,這些類型可以設定對應的Cc列表。 | ||
** 因為新版在更改Component時不會增加Cc列表,但這對於企業其實還蠻好用的,所以我自己包了一個版本在[https://github.com/gslin/defaultccplugin gslin/defaultccplugin]這邊。 | |||
* [https://trac-hacks.org/wiki/LDAPAcctMngrPlugin LDAPAcctMngrPlugin – Trac Hacks - Plugins Macros etc.] | |||
** 可以使用[[LDAP]]管理帳號,是AccountManagerPlugin的延伸套件。 | |||
** 要注意在文件上沒有提到需要安裝Pythoh module,<code>ldap</code>與<code>python-ldap</code>,需要自己手動裝。(這兩個模組需要一些系統的套件,可以透過<code>sudo apt install -y libsasl2-dev python-dev libldap2-dev libssl-dev</code>安裝) | |||
* [https://github.com/gslin/trac-addtocc-plugin gslin/trac-addtocc-plugin: Add participator to cc list automatically.] | |||
** 自動把參與者加到Cc列表內,這樣才會收到後續的更新。 | |||
* [https://github.com/gslin/trac-references-mail-decorator Add header's Message-ID field to References field for Trac.] | |||
** 當使用Amazon SES發信時,會因為<code>Message-ID</code>被換掉,而導致Mail Client無法透過<code>References</code>將同一張票的通知信整在一起。這個套件透過把信件本身的<code>Message-ID</code>複製一份到<code>References</code>的workaround讓Mail Client可以正確判斷出這些信件是同一張票。 | |||
* [https://github.com/gslin/trac-secret-checkbox-ticket gslin/trac-secret-checkbox-ticket: Add ticket security policy for Trac.] | * [https://github.com/gslin/trac-secret-checkbox-ticket gslin/trac-secret-checkbox-ticket: Add ticket security policy for Trac.] | ||
** 將票設定為祕密,只有Reporter(開票人)、Owner(目前有票的人)、Cc列表內的人可以讀。 | ** 將票設定為祕密,只有Reporter(開票人)、Owner(目前有票的人)、Cc列表內的人可以讀。 | ||
** 這對於企業內有些需求很好用。 | ** 這對於企業內有些需求很好用 (像是還在進行中的計畫,或是一些不會對全公司公開的數據) 。 | ||
* [https://trac-hacks.org/wiki/TracTicketReferencePlugin TracTicketReferencePlugin – Trac Hacks - Plugins Macros etc.] | |||
** 可以設定相關連的票,不過我很少用到這個功能(更多是子母票)。 | |||
== 設定 == | |||
=== 權限 === | |||
透過CLI的方式可以更新權限: | |||
<syntaxhighlight lang="bash"> | |||
trac-admin /path/to/myproject permission add admin TRAC_ADMIN | |||
</syntaxhighlight> | |||
Trac預設的權限設定過於嚴格,只給內部使用的情境下,建議對<code>authenticated</code>群組加上: | |||
* <code>TICKET_EDIT_CC</code> | |||
* <code>TICKET_EDIT_DESCRIPTION</code> | |||
=== conf/trac.ini === | |||
記得修改Logo網址: | |||
<syntaxhighlight lang="ini"> | |||
[header_logo] | |||
alt = Logo | |||
link = https://trac.example.com/ | |||
src = https://static.example.com/logo.png | |||
</syntaxhighlight> | |||
Trac可以設定預設發通知信件: | |||
<syntaxhighlight lang="ini"> | |||
[notification] | |||
smtp_default_domain = example.com | |||
smtp_enabled = enabled | |||
smtp_from = trac@trac.example.com | |||
smtp_replyto = noreply@trac.example.com | |||
use_public_cc = enabled | |||
</syntaxhighlight> | |||
我自己的Report不想分頁(預設是一頁100筆),所以設為: | |||
<syntaxhighlight lang="ini"> | |||
[report] | |||
items_per_page = 0 | |||
</syntaxhighlight> | |||
另外因為我們不太用Trac內建的Wiki, 但 又關不掉,所以只能針對 沒 找到 的 頁面就不要產生連結了 : | |||
<syntaxhighlight lang="ini"> | |||
[wiki] | |||
ignore_missing_pages = enabled | |||
</syntaxhighlight> | |||
[ | |||
</ | |||
=== | === htdoc/style.css === | ||
* 修正button因為CSS效果而有時會按不到的問題。 | * 修正button因為CSS效果而有時會按不到的問題。 | ||
* 針對今天到期與過期的票用不同的標示標出。 | * 針對code block內一行過長時自動換行。 | ||
* 將已經關掉的票變淡。 | * 針對今天到期與過期的票用不同的標示標出 (配合下方的JavaScript) 。 | ||
* 將已經關掉的票變淡 (配合下方的JavaScript) 。 | |||
* 讓編輯區域使用等寬字型。 | * 讓編輯區域使用等寬字型。 | ||
* 貼超長字串的時候不要產生橫向捲軸。 | |||
* 讓可用範圍變寬。 | * 讓可用範圍變寬。 | ||
* 讓圖片不要超過螢幕寬度。 | |||
<syntaxhighlight lang="css"> | |||
#changelog, #ticket { | |||
overflow-wrap: break-word; | |||
} | |||
#content.ticket { | |||
width: 78em; | |||
} | |||
#main img { | |||
max-width: 100%; | |||
} | |||
input[type=button]:active, input[type=submit]:active, | |||
input[type=reset]:active { | |||
position: relative; | |||
top: 0; | |||
left: 0; | |||
} | |||
pre { | |||
white-space: pre-wrap; | |||
} | |||
table.listing.tickets td { | |||
vertical-align: middle; | |||
} | |||
table.listing.tickets td.due_date, table.listing.tickets td.reporter { | |||
white-space: nowrap; | |||
} | |||
table.tickets tr.duedate_overdue { | |||
font-weight: bold; | |||
} | |||
table.tickets tr.duedate_today { | |||
border: 2px solid; | |||
} | |||
table.subtickets tr td:last-of-type { | |||
width: 15em; | |||
} | |||
table.subtickets tr.ticket_closed, .closed.ticket { | |||
opacity: 0.5; | |||
} | |||
textarea { | |||
font-family: monospace; | |||
} | |||
</syntaxhighlight> | |||
=== template/site_head.html === | |||
這是Trac 1.4的Jinja2設計,如果是Trac 1.2或更早版本的使用者,可以在<code>template/site.html</code>裡面增加。 | |||
<syntaxhighlight lang="html"> | |||
<meta name="referrer" content="no-referrer" /> | |||
<link rel="stylesheet" href="${href.chrome('site/style.css')}" /> | |||
<script src="https://cdn.jsdelivr.net/npm/strftime@0.10.0/strftime.min.js"></script> | |||
</syntaxhighlight> | |||
=== template/site_footer.html === | |||
這是Trac 1.4的Jinja2設計,如果是Trac 1.2或更早版本的使用者,可以在<code>template/site.html</code> 裡面增加。 | |||
</ | |||
* 用JavaScript針對今天到期以及過期的票增加CSS。 | * 用JavaScript針對今天到期以及過期的票增加CSS。 | ||
* 將新票裡的Due Date改為零點零分零秒。 | * 將新票裡的Due Date改為零點零分零秒。 | ||
* 增加把票直接延到下個月月底的button。 | |||
* 增加button,讓關票可以直接點擊。 | |||
* 將票裡的attachments與modify內容展開。 | * 將票裡的attachments與modify內容展開。 | ||
* 將日曆選擇器中, | * 將開票人的資訊放到Action欄位裡,比較好確認這張票的情況。 | ||
* 將日曆選擇器中, 關閉動畫效果<ref name="jqueryui-datepicker">{{Cite web|url=https://api.jqueryui.com/datepicker/|title=Datepicker Widget | jQuery UI API Documentation|accessdate=2018-02-28}}</ref> , 另外 將每週的第一天設為星期天<ref name="jqueryui-datepicker"/>,並且 允許選擇其他月份的日期<ref name="jqueryui-datepicker"/> 。 | |||
* 對所有<code>button</code>都設定accesskey 。 | |||
< | <syntaxhighlight lang="html"> | ||
<script> | |||
<!-- | |||
'use strict'; | |||
// Run immediately. | |||
(function($) { | |||
// Due date css handling | |||
let d = new Date(); | |||
let today = (new Date(d.getTime() - d.getTimezoneOffset() * 60000)).toISOString().slice(0, 10); | |||
document.querySelectorAll('table.tickets td.due_date').forEach(function(el) { | |||
let due = el.innerText.trim(); | |||
if (due < today) { | |||
el.parentElement.classList.add('duedate_overdue'); | |||
} else if (due === today) { | |||
el.parentElement.classList.add('duedate_today'); | |||
} | |||
}); | |||
// Due date (newticket) set to 00:00:00 (in UTC) | |||
if ($('form[action$="/newticket#ticket"]').length > 0) { | |||
do { | |||
if ($('#ticket:visible').hasClass('ticketdraft')) { | |||
break; | |||
} | |||
let el = $('#field-due_date'); | |||
let t = el.val(); | |||
if ('Z' === t.slice(-1)) { | |||
t = new Date(Date.parse(t) + 86400000); | |||
t = strftime('%Y-%m-%dT00:00:00Z', t); | |||
el.val(t); | |||
break; | |||
} | |||
let a = t.match(/\+(\d\d:\d\d)$/); | |||
if (null !== a) { | |||
let tz = a[1]; | |||
let new_str = 'T' + tz + ':00+' + tz; | |||
t = new Date(Date.parse(t) + 86400000); | |||
t = strftime('%Y-%m-%d' + new_str, t); | |||
el.val(t); | |||
break; | |||
} | } | ||
} while (false); | |||
} | |||
// Due date postpone button | |||
let el = $('<button>Postpone (month)</button>'); | |||
el.click(function(){ | |||
let el = $('#field-due_date'); | |||
let t = el.val(); | |||
do { | |||
if ('Z' === t.slice(-1)) { | |||
t = new Date(Date.now()); | |||
t.setDate(1); | |||
t.setMonth(t.getMonth() + 2); | |||
t.setDate(0); | |||
t = strftime('%Y-%m-%dT00:00:00Z', t); | |||
el.val(t); | |||
break; | |||
} | |||
let a = t.match(/\+(\d\d:\d\d)$/); | |||
if (null !== a) { | |||
let tz = a[1]; | |||
let new_str = 'T' + tz + ':00+' + tz; | |||
t = new Date(Date.now()); | |||
t.setDate(1); | |||
t.setMonth(t.getMonth() + 2); | |||
t.setDate(0); | |||
t = strftime('%Y-%m-%d' + new_str, t); | |||
el.val(t); | |||
break; | |||
} | |||
} while (false); | |||
$('#propertyform input[name="submit"]').click(); | |||
}); | |||
$('td[headers="h_due_date"]').append(el); | |||
// Accept & start buttons | |||
$('#action_accept, #action_start').each(function(){ | |||
var v = $(this).val(); | |||
var that = this; | |||
var b = $('<button/>').click(function(e){ | |||
var v = $(this).val(); | |||
$(that).click(); | |||
$('#propertyform input[name="submit"]').click(); | |||
e.preventDefault(); | |||
}); | }); | ||
b.prop('value', v).text(v); | |||
$(this).closest('div').append(b); | |||
}); | |||
// Resolve with Buttons | |||
$('#action_resolve_resolve_resolution option').each(function(){ | |||
var v = $(this).val(); | |||
/ | var b = $('<button/>').click(function(e){ | ||
var v = $(this).val(); | |||
$('#action_resolve').click(); | |||
$('#action_resolve_resolve_resolution').prop('disabled', false); | |||
$('#action_resolve_resolve_resolution').find('option[value="' + v + '"]').prop('selected', 'selected'); | |||
$('#propertyform input[name="submit"]').click(); | |||
e.preventDefault(); | |||
}); | |||
b.prop('value', v).text(v); | |||
$(this).closest('div').append(b); | |||
}); | |||
} | |||
// Run after content loaded. | // Run after content loaded. | ||
$(function() { | |||
// Reset Drag & Drop hovering issue. | |||
let el = document.querySelector('.tracdragdrop-paste.beautytips'); | |||
el?.parentElement.addEventListener('mouseover', ev => {ev.stopPropagation();}, true); | |||
// Layout | // Layout | ||
$('#attachments').removeClass('collapsed'); | |||
$('#modify').parent().removeClass('collapsed'); | |||
// Datepicker | |||
if ($.datepicker) { | |||
$.datepicker.setDefaults({ | |||
firstDay: 0, | |||
selectOtherMonths: true, | |||
showAnim: '', | |||
showOtherMonths: true | |||
}); | |||
} | |||
// Add accesskey | |||
$('button').each(function() { | |||
var el = $(this); | |||
var a = el.text()[0].toLowerCase(); | |||
el.attr('accesskey', a); | |||
}); | |||
// Add submit accesskey | |||
$('input[name="submit"]').each(function() { | |||
$(this).attr('accesskey', 'c'); | |||
}); | |||
// Closed tickets handling | |||
$('tr:has(a.closed)').addClass('ticket_closed'); | |||
}); | }); | ||
})(jQuery); | |||
</ | //--> | ||
</script> | |||
</syntaxhighlight> | |||
== 其他 == | |||
刪除使用者時可能會需要手動到以下表格清除資料(清完後需要重跑Trac,因為Trac會讀出來cache一份),避免autocomplete之類的套件仍然顯示: | |||
* auth_cookie | |||
* session | |||
* session_attribute | |||
== 著名使用單位 == | |||
* Django | |||
* FFmpeg | |||
* jQuery | |||
* MacPorts | |||
* nginx | |||
* OpenVPN | |||
* Tor(2020年六月終止<ref>{{Cite web |url=https://blog.torproject.org/node/1957 |title=From Trac into Gitlab for Tor |accessdate=2020-11-22 |date=2020-11-20 |language=en}}</ref> ) | |||
* VirtualBox | |||
* WebKit | |||
* WordPress | |||
== 相關連結 == | |||
* [[Trac/Manual]] | |||
== 參考資料 == | == 參考資料 == |
2024年2月20日 (二) 13:41的最新版本
Trac是一套问题追踪系统(英语:Issue tracking system)。
简介
优点
- 简单,专注在事情的记录上,而不是限制行为上。
缺点
目前的版本(1.4)还是不支援Python 3,但1.5已经在开发了。目前支援Python 3的1.6版已经出了。
安装
我是将Python装在service-trac
这个使用者的pyenv里面(权限会是service-trac:service-trac
)。在装完Python后,用pip
安装以下套件:
sudo apt install -y libmysqlclient-dev
pip install mysqlclient pytz PyMySQL Pygments Trac
使用MariaDB时需要把改变dependency:
sudo apt install -y libmariadb-dev
pip install mysqlclient pytz PyMySQL Pygments Trac
使用MySQL或是MariaDB作为后端数据库时,建议用utf8mb4作为基础,这样数据库可以存所有范围的Unicode字元[1],另外建立独立的使用者供Trac使用:
CREATE DATABASE trac DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
CREATE USER `trac`@`127.0.0.1` IDENTIFIED BY 'password_here';
GRANT ALL ON trac.* TO `trac`@`127.0.0.1`;
接下来就可以产生环境:
cd ~; trac-admin trac initenv
这边在安装Trac时的数据库连线设定会是mysql://trac:password_here@127.0.0.1/trac
(需要自己修改对应字段)。
在安装套件时,软件本体常常会放在Subversion的服务器内,在透过pip
或是easy_install
时会呼叫Subversion,所以会需要安装对应的软件:
sudo apt install -y subversion
另外要建立目录(放附件之类的东西):
cd ~; mkdir trac/files
FastCGI
然后是Trac的FastCGI档案,放在Trac的project目录下,并且用chmod 755 trac.fcgi
改成可执行,这边的num
是指跑daemon的数量,通常可以设定成与CPU或是vCPU数量相同的数字:
#!/usr/bin/env python3
import os
from trac.web.main import dispatch_request
import trac.web._fcgi
num = 4
sockaddr = os.path.expanduser('~') + '/trac/trac.sock'
os.environ['TRAC_ENV'] = os.path.dirname(__file__)
fcgiserv = trac.web._fcgi.WSGIServer(dispatch_request, bindAddress = sockaddr, umask = 7)
for _ in range(num - 1):
if 0 == os.fork():
break
fcgiserv.run()
另外使用userland systemd(需要先启用这个设定),让Trac在开机时将FastCGI daemon跑起来,这个档案放在~/.config/systemd/user/trac-fcgi.service
:
[Unit]
Description=Trac FastCGI daemon
After=remote-fs.target
[Service]
ExecStart=/bin/bash -l -c "exec ~/trac/trac.fcgi"
Type=simple
[Install]
WantedBy=default.target
然后让systemd重新读取,并且设定为开机启动,最后手动先跑起来(或是重开机):
systemctl --user daemon-reload
systemctl --user enable --now trac-fcgi.service
另外要让nginx可以存取/var/run/trac/trac.sock
,然后完全重跑nginx:
sudo useradd -G service-trac www-data; sudo service nginx restart
套件
目前有安装的套件
除了基本安装外,还会安装这些套件:
- AccountManagerPlugin – Trac Hacks - Plugins Macros etc.
- 可以吃HTML Form Login,而不局限在HTTP authentication。
- BlueFlatTheme – Trac Hacks - Plugins Macros etc.
- 目前Trac上少数支援Responsive Design的Theme,需要使用ThemeEnginePlugin安装并启用。
- DuplicateTicketSearchPlugin – Trac Hacks - Plugins Macros etc.
- 在开新票时可以拉出有哪些是可能重复的票(尤其是已经关掉的票)。
- GraphvizPlugin – Trac Hacks - Plugins Macros etc.
- Graphviz可以拿来画各类图,我自己最常用的是Dot图。
- SlackIntegration – Trac Hacks - Plugins Macros etc.
- 可以把变更丢到Slack上,这边要注意的是套件本身没有把相依性做好,需要自己安装
requests
套件。在Trac 1.6上面因为Python 3的原因会有问题,可以装我修的版本。
- 可以把变更丢到Slack上,这边要注意的是套件本身没有把相依性做好,需要自己安装
- SubticketsPlugin – Trac Hacks - Plugins Macros etc.
- 子母票的延伸套件,基本上是必备项目。原版的程式安装在MySQL 8.0的环境下会出问题(也不支援Trac 1.6),可以用我修的版本。
- ThemeEnginePlugin – Trac Hacks - Plugins Macros etc.
- Theme的套件管理工具,配合BlueFlatTheme用的。
- TracCronPlugin – Trac Hacks - Plugins Macros etc.
- 定时跑任务,但其实没很好用... 目前主要是拿来每天寄信通知有哪些票过期。
- TracDragDropPlugin – Trac Hacks - Plugins Macros etc.
- 拖拉就可以上传附件的套件。
- TracWysiwygPlugin – Trac Hacks - Plugins Macros etc.
- 可以针对Textarea区块使用WYSIWYG界面,对于非技术类的使用者来说会方便不少(因为不需要学Trac的Wiki语法)。另外有不少文件可以直接剪下贴上(虽然还是会掉不少效果,但比起完全不能剪下贴上来说已经方便不少)。
- XmlRpcPlugin – Trac Hacks - Plugins Macros etc.
- 让使用者可以透过API操作Trac。
目前Trac 1.4版的安装方式是:
#!/bin/bash
pip install -U TracCronPlugin
pip install -U genshi
pip install -U git+https://github.com/gslin/trac-subtickets-plugin.git
pip install -U git+https://github.com/gslin/trac-slack-plugin.git
pip install -U requests
pip install -U svn+https://trac-hacks.org/svn/accountmanagerplugin/trunk/
pip install -U svn+https://trac-hacks.org/svn/duplicateticketsearchplugin/trunk/
pip install -U svn+https://trac-hacks.org/svn/graphvizplugin/branches/1.2/
pip install -U svn+https://trac-hacks.org/svn/tracdragdropplugin/0.12/
pip install -U svn+https://trac-hacks.org/svn/tracwysiwygplugin/0.12/
pip install -U svn+https://trac-hacks.org/svn/xmlrpcplugin/trunk/
对应的requirements.txt
是:
-e git+https://github.com/gslin/trac-subtickets-plugin.git
-e git+https://github.com/gslin/trac-slack-plugin.git
-e svn+https://trac-hacks.org/svn/accountmanagerplugin/trunk/
-e svn+https://trac-hacks.org/svn/duplicateticketsearchplugin/trunk/
-e svn+https://trac-hacks.org/svn/graphvizplugin/branches/1.2/
-e svn+https://trac-hacks.org/svn/tracdragdropplugin/0.12/
-e svn+https://trac-hacks.org/svn/tracwysiwygplugin/0.12/
-e svn+https://trac-hacks.org/svn/xmlrpcplugin/trunk/
TracCronPlugin
genshi
requests
可以用pip install -r requirements.txt
安装。
曾经装过的套件
以前会安装,但现在因为自己用而没有装上(没有需求或是不想装):
- AutocompleteUsersPlugin – Trac Hacks - Plugins Macros etc.
- 让使用者账号名称可以autocomplete,在Cc字段与Owner字段会很好用。
- DefaultCcPlugin – Trac Hacks - Plugins Macros etc.
- 针对不同的Component自动加上Cc列表。
- 对于企业内还蛮有用的。像是专案可以开
Proj.
开头的Component,而组织可以开Org.
开头的Component,这些类型可以设定对应的Cc列表。 - 因为新版在更改Component时不会增加Cc列表,但这对于企业其实还蛮好用的,所以我自己包了一个版本在gslin/defaultccplugin这边。
- LDAPAcctMngrPlugin – Trac Hacks - Plugins Macros etc.
- 可以使用LDAP管理账号,是AccountManagerPlugin的延伸套件。
- 要注意在文件上没有提到需要安装Pythoh module,
ldap
与python-ldap
,需要自己手动装。(这两个模组需要一些系统的套件,可以透过sudo apt install -y libsasl2-dev python-dev libldap2-dev libssl-dev
安装)
- gslin/trac-addtocc-plugin: Add participator to cc list automatically.
- 自动把参与者加到Cc列表内,这样才会收到后续的更新。
- Add header's Message-ID field to References field for Trac.
- 当使用Amazon SES发信时,会因为
Message-ID
被换掉,而导致Mail Client无法透过References
将同一张票的通知信整在一起。这个套件透过把信件本身的Message-ID
复制一份到References
的workaround让Mail Client可以正确判断出这些信件是同一张票。
- 当使用Amazon SES发信时,会因为
- gslin/trac-secret-checkbox-ticket: Add ticket security policy for Trac.
- 将票设定为秘密,只有Reporter(开票人)、Owner(目前有票的人)、Cc列表内的人可以读。
- 这对于企业内有些需求很好用(像是还在进行中的计划,或是一些不会对全公司公开的数据)。
- TracTicketReferencePlugin – Trac Hacks - Plugins Macros etc.
- 可以设定相关连的票,不过我很少用到这个功能(更多是子母票)。
设定
权限
透过CLI的方式可以更新权限:
trac-admin /path/to/myproject permission add admin TRAC_ADMIN
Trac预设的权限设定过于严格,只给内部使用的情境下,建议对authenticated
群组加上:
TICKET_EDIT_CC
TICKET_EDIT_DESCRIPTION
conf/trac.ini
记得修改Logo网址:
[header_logo]
alt = Logo
link = https://trac.example.com/
src = https://static.example.com/logo.png
Trac可以设定预设发通知信件:
[notification]
smtp_default_domain = example.com
smtp_enabled = enabled
smtp_from = trac@trac.example.com
smtp_replyto = noreply@trac.example.com
use_public_cc = enabled
我自己的Report不想分页(预设是一页100笔),所以设为:
[report]
items_per_page = 0
另外因为我们不太用Trac内建的Wiki,但又关不掉,所以只能针对没找到的页面就不要产生连结了:
[wiki]
ignore_missing_pages = enabled
htdoc/style.css
- 修正button因为CSS效果而有时会按不到的问题。
- 针对code block内一行过长时自动换行。
- 针对今天到期与过期的票用不同的标示标出(配合下方的JavaScript)。
- 将已经关掉的票变淡(配合下方的JavaScript)。
- 让编辑区域使用等宽字型。
- 贴超长字串的时候不要产生横向卷轴。
- 让可用范围变宽。
- 让图片不要超过萤幕宽度。
#changelog, #ticket {
overflow-wrap: break-word;
}
#content.ticket {
width: 78em;
}
#main img {
max-width: 100%;
}
input[type=button]:active, input[type=submit]:active,
input[type=reset]:active {
position: relative;
top: 0;
left: 0;
}
pre {
white-space: pre-wrap;
}
table.listing.tickets td {
vertical-align: middle;
}
table.listing.tickets td.due_date, table.listing.tickets td.reporter {
white-space: nowrap;
}
table.tickets tr.duedate_overdue {
font-weight: bold;
}
table.tickets tr.duedate_today {
border: 2px solid;
}
table.subtickets tr td:last-of-type {
width: 15em;
}
table.subtickets tr.ticket_closed, .closed.ticket {
opacity: 0.5;
}
textarea {
font-family: monospace;
}
template/site_head.html
这是Trac 1.4的Jinja2设计,如果是Trac 1.2或更早版本的使用者,可以在template/site.html
里面增加。
<meta name="referrer" content="no-referrer" />
<link rel="stylesheet" href="${href.chrome('site/style.css')}" />
<script src="https://cdn.jsdelivr.net/npm/strftime@0.10.0/strftime.min.js"></script>
这是Trac 1.4的Jinja2设计,如果是Trac 1.2或更早版本的使用者,可以在template/site.html
里面增加。
- 用JavaScript针对今天到期以及过期的票增加CSS。
- 将新票里的Due Date改为零点零分零秒。
- 增加把票直接延到下个月月底的button。
- 增加button,让关票可以直接点击。
- 将票里的attachments与modify内容展开。
- 将开票人的资讯放到Action字段里,比较好确认这张票的情况。
- 将日历选择器中,关闭动画效果[2],另外将每周的第一天设为星期天[2],并且允许选择其他月份的日期[2]。
- 对所有
button
都设定accesskey。
<script>
<!--
'use strict';
// Run immediately.
(function($) {
// Due date css handling
let d = new Date();
let today = (new Date(d.getTime() - d.getTimezoneOffset() * 60000)).toISOString().slice(0, 10);
document.querySelectorAll('table.tickets td.due_date').forEach(function(el) {
let due = el.innerText.trim();
if (due < today) {
el.parentElement.classList.add('duedate_overdue');
} else if (due === today) {
el.parentElement.classList.add('duedate_today');
}
});
// Due date (newticket) set to 00:00:00 (in UTC)
if ($('form[action$="/newticket#ticket"]').length > 0) {
do {
if ($('#ticket:visible').hasClass('ticketdraft')) {
break;
}
let el = $('#field-due_date');
let t = el.val();
if ('Z' === t.slice(-1)) {
t = new Date(Date.parse(t) + 86400000);
t = strftime('%Y-%m-%dT00:00:00Z', t);
el.val(t);
break;
}
let a = t.match(/\+(\d\d:\d\d)$/);
if (null !== a) {
let tz = a[1];
let new_str = 'T' + tz + ':00+' + tz;
t = new Date(Date.parse(t) + 86400000);
t = strftime('%Y-%m-%d' + new_str, t);
el.val(t);
break;
}
} while (false);
}
// Due date postpone button
let el = $('<button>Postpone (month)</button>');
el.click(function(){
let el = $('#field-due_date');
let t = el.val();
do {
if ('Z' === t.slice(-1)) {
t = new Date(Date.now());
t.setDate(1);
t.setMonth(t.getMonth() + 2);
t.setDate(0);
t = strftime('%Y-%m-%dT00:00:00Z', t);
el.val(t);
break;
}
let a = t.match(/\+(\d\d:\d\d)$/);
if (null !== a) {
let tz = a[1];
let new_str = 'T' + tz + ':00+' + tz;
t = new Date(Date.now());
t.setDate(1);
t.setMonth(t.getMonth() + 2);
t.setDate(0);
t = strftime('%Y-%m-%d' + new_str, t);
el.val(t);
break;
}
} while (false);
$('#propertyform input[name="submit"]').click();
});
$('td[headers="h_due_date"]').append(el);
// Accept & start buttons
$('#action_accept, #action_start').each(function(){
var v = $(this).val();
var that = this;
var b = $('<button/>').click(function(e){
var v = $(this).val();
$(that).click();
$('#propertyform input[name="submit"]').click();
e.preventDefault();
});
b.prop('value', v).text(v);
$(this).closest('div').append(b);
});
// Resolve with Buttons
$('#action_resolve_resolve_resolution option').each(function(){
var v = $(this).val();
var b = $('<button/>').click(function(e){
var v = $(this).val();
$('#action_resolve').click();
$('#action_resolve_resolve_resolution').prop('disabled', false);
$('#action_resolve_resolve_resolution').find('option[value="' + v + '"]').prop('selected', 'selected');
$('#propertyform input[name="submit"]').click();
e.preventDefault();
});
b.prop('value', v).text(v);
$(this).closest('div').append(b);
});
// Run after content loaded.
$(function() {
// Reset Drag & Drop hovering issue.
let el = document.querySelector('.tracdragdrop-paste.beautytips');
el?.parentElement.addEventListener('mouseover', ev => {ev.stopPropagation();}, true);
// Layout
$('#attachments').removeClass('collapsed');
$('#modify').parent().removeClass('collapsed');
// Datepicker
if ($.datepicker) {
$.datepicker.setDefaults({
firstDay: 0,
selectOtherMonths: true,
showAnim: '',
showOtherMonths: true
});
}
// Add accesskey
$('button').each(function() {
var el = $(this);
var a = el.text()[0].toLowerCase();
el.attr('accesskey', a);
});
// Add submit accesskey
$('input[name="submit"]').each(function() {
$(this).attr('accesskey', 'c');
});
// Closed tickets handling
$('tr:has(a.closed)').addClass('ticket_closed');
});
})(jQuery);
//-->
</script>
其他
删除使用者时可能会需要手动到以下表格清除资料(清完后需要重跑Trac,因为Trac会读出来cache一份),避免autocomplete之类的套件仍然显示:
- auth_cookie
- session
- session_attribute
著名使用单位
- Django
- FFmpeg
- jQuery
- MacPorts
- nginx
- OpenVPN
- Tor(2020年六月终止[3])
- VirtualBox
- WebKit
- WordPress
相关连结
参考资料
- ↑ MySqlDb – The Trac Project. [2018-03-01].
- ↑ 2.0 2.1 2.2 Datepicker Widget | jQuery UI API Documentation. [2018-02-28].
- ↑ From Trac into Gitlab for Tor. 2020-11-20 [2020-11-22] (English).