這是本文件的舊版！

RFDoc

Introduction

RFDoc是一個讓你可以將所有的Keyowrd Documents集中管理的Web應用程式。對於一個Team的開發人員來說，除了透過瀏覽各個Keyword Documents外，也可以透過搜尋功能去知道目前專案中有哪些既有的Keyword可以用。

Install and Setup

RFDoc使用Django為Web的Framework並以sqlite3為資料庫。我分為兩部分做介紹，一個以Django做為Web Server，一個是以Apache做為Web Server。(官網的教學實在令我覺得OOXX，照著它做8成以上不能work)

Django Web Server

Django提供的Web Server目的是為了開發與測試使用，但如果只是拿來跑RFDoc也無妨吧!

  1. 安裝Djando: 
    apt-get install python-django
  2. 下載rfdoc並解壓縮，我解壓縮至/usr/src/rfdoc-0.2。
  3. 建置與安裝: 至安裝目錄下執行以下指令，會產生src的資料夾，
    python setup.py install
  4. 設置DB: 
    python src/rfdoc/manage.py syncdb
  5. 啟動: 可根據需求決定要使用的port， 
    python src/rfdoc/manage.py runserver 0.0.0.0:8000

如果要重新初始化RFDoc使用的database，可以執行

python src/rfdoc/manage.py reset rfdocapp

Apache Web Server

它是透過WSGI的interface讓Apache Web Server去存取RFDoc。除了要安裝Django的部分，還要做以下安裝:

  1. 安裝apache: 
    sudo apt-get install apache2
  2. 安裝wsgi模組: 
    sudo apt-get install libapache2-mod-wsgi
  3. 產生wsgi檔: 直接使用Template，
    cp /usr/src/rfdoc-0.2/src/rfdoc/rfdoc.wsgi.tmpl /usr/src/rfdoc-0.2/src/rfdoc/rfdoc.wsgi
    加入src/rfdoc的路徑到PATHS中，
    PATHS = ['/usr/src/rfdoc-0.2/src/rfdoc']
  4. 設定檔: 新增對rfdoc的apache設定擋，
    WSGIScriptAlias / /opt/tmp/rfdoc-0.2/src/rfdoc/rfdoc.wsgi
  5. 修改資料庫存取權限: 目的是要讓apache有rfdoc資料庫存取的權限，
    chown www-data:www-data /tmp/rfdoc.db

由於RFDoc程式碼都是使用Web Root的方式去存取，目前還在尋找可以讓它透過其它URL存取的方式。

Automatic Gen&Upload

curl --form file=@/opt/portable-robot/doc/CommonUtil.xml http://10.134.15.215/upload --form override=on

Reference