Hostsharing Wiki - Benutzerbeiträge [de]

Nextcloud

2022-02-26T10:18:49Z

Mih17-bernhard: Hinweise zur Konfiguration des data-Verzeichnisses und auf aktuelle Nextcloud-Version 23.0.2

= Nextcloud =

[https://nextcloud.com/ Nextcloud] ist eine PHP-basierte Open Source Lösung für gängige Cloud-Anwendungen, u.a.:

* Filesharing unter Nutzern derselben Nextcloud, und mit der Öffentlichkeit
* Single-Sign-On Authentifizierung (SSO)
* Videokonferenzen (WebRTC)
* Online-Office Anwendung [https://www.collaboraoffice.com/ Collabora Online]

Beispiel-Funktionalität, die über Plugins, sogenannte [https://apps.nextcloud.com/ "Apps"], bereit gestellt werden kann:

* Kalender, Aufgabenverwaltung, Adressbuch
* Datei-Kollaboration (Kommentare zu Dateien, Verschlagwortung)
* Feedreader
* E-Mail-Programm
* Fotogalerie
* Musik- und Videowiedergabe

= Nextcloud installieren =

== Vorbereitungen ==

In ''hsadmin'', zum Beispiel mit ''hsscript'':

''hsadmin''-Shell starten mit:

hsscript -u xyz00 -i
Password: ********

Dann nacheinander anlegen:

* Linux User als Domain-Administrator
* Subdomain ''cloud.example.org''
* PostgreSQL-User
* PostgreSQL Datenbank

xyz00@hsadmin> user.add({set:{name:'xyz00-cloud',password:'geheim',shell:'/bin/bash',comment:'Nextcloud'}})
xyz00@hsadmin> domain.add({set:{name:'cloud.example.org',user:'xyz00-cloud'}})
xyz00@hsadmin> postgresqluser.add({set:{name:'xyz00_nextclusr',password:'geheim'}})
xyz00@hsadmin> postgresqldb.add({set:{name:'xyz00_nextcloud',owner:'xyz00_nextclusr'}})

== Nextcloud installieren ==

Anmelden als Linux-User ''xyz00-cloud'':

ssh -l xyz00-cloud xyz00.hostsharing.net

''htdocs'' Verzeichnis vorbereiten

cd
mkdir nextcloud
cd doms/cloud.example.org
rm -rf subs/www subs-ssl/www htdocs-ssl
ln -s $HOME/nextcloud htdocs-ssl

Nextcloud herunterladen und entpacken.

cd
wget https://download.nextcloud.com/server/releases/nextcloud-22.2.0.zip
unzip nextcloud-22.2.0.zip
rm nextcloud-22.2.0.zip
mkdir data tmp
chmod 700 data tmp

Mit Erolg getestete neuere Versionen:
* nextcloud-23.0.2 (user mih17)

== Nextcloud konfigurieren ==

Im Verzeichnis "$HOME/doms/cloud.example.org/fastcgi-ssl/" eine Datei "php.ini" anlegen mit folgendem Inhalt:

memory_limit=512M
session.save_path=/home/pacs/xyz00/users/cloud/tmp

Dann mit einem Editor diese Datei bearbeiten: In der zweiten Zeile den korrekten Pfad des vorher angelegten tmp-Verzeichnisses eintragen.

Im Browser auf die Seite
http://cloud.example.org gehen und den Anweisungen folgen.

Auf der ersten Seite sind anzugeben:

* Login und Passwort für den Administrator definieren
* PostgreSQL als Datenbanksystem
* PostgreSQL-User und Passwort aus dem ersten Schritt oben
* Name der PostgreSQL-Datenbank aus dem ersten Schritt
* "localhost" als Datenbankserver (Nextcloud 23.0.2 empfiehlt hier die Angabe des Ports, diesen also lt. [[PostgreSQL]] angeben)
* Das Verzeichnis "/home/pacs/xyz00/users/cloud/data/" als Daten-Verzeichnis (bitte beachten: das im Eingabefeld voreingestellte verweist auf das Verzeichnis "/home/pacs/xyz00/users/cloud/'''nextcloud'''/data/")

'''Achtung!''' Die Felder für die Datenbank sind auf dem Startscreen hinter einem unscheinbaren Link versteckt. Um man das Formular für die Datenbank-Daten zu gelangen, muss man auf den Link klicken. Anschließend kann man die gewünschte Datenbank auswählen und die entsprechenden Daten eintragen. '''Das sollte geschehen, bevor man die Installation abschließt!''' Tut man dies nicht, wird Nextcloud mit SQLite installiert. Eine Änderung der Datenbank soll zwar laut Dokumentation auch später noch möglich sein, ging aber bei einem Test schief.

== Nextcloud beschleunigen ==

Dieser Teil ist optional.

Wenn regelmäßig '''im Browser''' mit Nextcloud gearbeitet werden soll, ist Nextcloud im Browser oft sehr langsam. Um dies zu verbessern, unterstützt Nextcloud die Anwendung von unterschiedlichen Cache-Verfahren (zum Beispiel Memcache, Redis).

Redis ist auf den Hostsharing-Servern vorinstalliert und wird von den Nextcloud-Entwicklern empfohlen. '''In Verbindung mit einem Managed Webspace''' muss Redis als eigener Server '''Daemon''' angemeldet werden und ist '''kostenpflichtig'''. Siehe zu Kosten im Webspace Konfigurator unter: https://www.hostsharing.net/angebote/managed-webspace/ – '''1 individueller Serverdienst''' (Daemons).

Mit dem Hostsharing-Service wird ein IP-Port für die Nutzung von Redis vereinbart.

Für den Redis-Dienst lege ich folgende Struktur an:

cd ~
mkdir -p ~/redis/etc
mkdir -p ~/redis/var

In ''~/redis/etc'' lege ich eine Konfigurationsdatei ''redis.conf'' für den Redis-Dienst ab:

daemonize yes
pidfile /home/pacs/xyz00/users/cloud/redis/var/redis-server.pid
requirepass mein-redis-passwort
unixsocket /home/pacs/xyz00/users/cloud/redis/var/redis-server.sock
unixsocketperm 700
port 0
tcp-backlog 128
timeout 300
loglevel notice
logfile /home/pacs/xyz00/users/cloud/redis/var/redis.log
databases 16
save 900 1
save 300 10
save 60 10000
slave-serve-stale-data yes
appendonly no
dbfilename dump.rdb
dir /home/pacs/xyz00/users/cloud/redis/var

Den Start und das Monitoring des Redis-Dienstes übernimmt ''monit''. Hier eine geeignete Datei ''~/.monitrc'':

set daemon 60
with start delay 20
set logfile /home/pacs/xyz00/users/cloud/monit/var/monit.log
set idfile /home/pacs/xyz00/users/cloud/monit/var/monit.id
set statefile /home/pacs/xyz00/users/cloud/monit/var/monit.state
set httpd unixsocket /home/pacs/xyz00/users/cloud/monit/var/monit.sock
permission 600
allow monit:mein-monit-passwort
check process redis with pidfile /home/pacs/xyz00/users/cloud/redis/var/redis-server.pid
start program "/usr/bin/redis-server /home/pacs/xyz00/users/cloud/redis/etc/redis.conf"
stop program "/bin/bash -c '/bin/kill $( cat /home/pacs/xyz00/users/cloud/redis/var/redis-server.pid )'"

Zugriffsrechte für die Datei ''~/.monitrc'' setzen:

cd ~
chmod 600 .monitrc

Verzeichnis für ''monit'' anlegen:

cd ~
mkdir -p monit/var

In der Konfiguration der Nextcloud (in ''~/nextcloud/config/config.php'') wird der Redis-Cache wie folgt konfiguriert:

'memcache.local' => '\\OC\\Memcache\\Redis',
'memcache.distributed' => '\\OC\\Memcache\\Redis',
'memcache.locking' => '\\OC\\Memcache\\Redis',
'redis' =>
array (
'host' => '/home/pacs/xyz00/users/cloud/redis/var/redis-server.sock',
'port' => 0,
'password' => 'mein-redis-passwort',
'timeout' => 1.5,
),

Um es perfekt zu machen, nutze ich ''logrotate'' um die Logdateien zu organisieren. Dazu die Konfiguration in ''~/.logrotate''

compress
/home/pacs/xyz00/users/cloud/redis/var/redis.log {
rotate 5
daily
missingok
}
/home/pacs/xyz00/users/cloud/monit/var/monit.log {
rotate 2
weekly
missingok
}

Eine Crontab sorgt für den Start von Monit und das tägliche Rotieren der Logdateien:

# m h dom mon dow command
HOME=/home/pacs/xyz00/users/cloud
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
MAILTO=webmaster@example.com
@reboot /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
*/5 * * * * /usr/bin/php $HOME/nextcloud/cron.php

Die letzte Zeile der ''crontab'' enthält den Cronjob für die regelmäßigen Hintergrundprozesse der Nextcloud. Durch die Erledigung dieser Aufgaben mit Cron lässt sich die Nextcloud ebenfalls etwas beschleunigen.

== Nextcloud mit Online Office ==

In Nextcloud können Office-Dokumente (Textverarbeitung, Tabellen und Präsentationen) im Browser bearbeitet werden. Dazu steht bei Hostsharing die Collabora Developer Version zur Verfügung. Bestellung und Konfiguration sind hier im Wiki auf der Seite [[Collabora_Online]] beschrieben.

== Nextcloud mit Nextcloud Talk ==

Über die Nextcloud-App "Talk" können Videokonfererenzen mit Screensharing durchgeführt werden. Für die regelmäßige Nutzung kann es sinnvoll sein einen eigenen TURN Server zu betreiben. Siehe dazu [[Coturn_Installieren]]

== Volltextsuche ==

Über die Dokumente einer Nextcloud kann ein Volltextindex erstellt werden. Die Volltextsuche ermöglicht über den Index eine Suche über beliebige Begriffe, die in Dokumenten vorkommen.

Voraussetzung ist der Betrieb eines Elasticsearch Servers. Der Betrieb im Managed Webspace erfodert die Buchung von zwei "Serverdiensten". Nutzer eines Managed Server müssen mit einem spürbaren Mehrbedarf an Hauptspeicher rechnen.

Zur Installation von Elasticsearch existiert eine eigene Wikiseite: [[Elasticsearch]].

In der Nextcloud sind folgende ''Apps'' zu installieren:
* Full Text Search
* Full Text Search - Elasticsearch Platform
* Full Text Search - Files

nach der Installation der drei Apps steht in den Einstellungen ein neuer Menüpunkt "Volltextsuche" zur Verfügung.

Hier ist einzustellen:
* Suchplattform: Elasticsearch
* Adresse des Servlets: http://elastic:das-erzeugt-passwort@127.0.0.1:39200
* Index: frei-gewaehlter-name-idx
* Analyzer tokenizer: standard

Die anderen Einstellung nach den eigenen Vorstellungen vornehmen.

Der initiale Aufbau des Suchindex erfolgt über ein "occ"-Kommando auf der Shell:

cd nextcloud/
php occ fulltextsearch:index --output

Wenn dieser Fehler kommt:
TypeError: Return value of OCA\Files_FullTextSearch\Model\MountPoint::isGlobal()
must be of the type bool, null returned in [...]/apps/files_fulltextsearch/lib/Model/MountPoint.php:103
sollte dieser Patch angewendet werden: https://github.com/nextcloud/files_fulltextsearch/issues/125#issuecomment-877789742

Zur Pflege des Indexes wird ein weiterer Hintergrundprozess gestartet:

cd nextcloud/
php occ fulltextsearch:live -q

Die Monit Konfiguration dafür sieht so aus:

~/bin/start-fulltextsearchlive
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
cd $HOME
mkdir -p $HOME/var
cd $HOME/nextcloud
exec php occ fulltextsearch:live -q &
echo $! >$HOME/var/fulltextsearchlive.pid

~/bin/stop-fulltextsearchlive
#!/bin/bash
export HOME=/home/pacs/xyz00/users/cloud
kill $( cat $HOME/var/fulltextsearchlive.pid )

~/.monitrc (siehe oben von der Redis Installation) entsprechend ergänzen:
check process fulltextsearchlive with pidfile /home/pacs/xyz00/users/cloud/var/fulltextsearchlive.pid
start program "/home/pacs/xyz00/users/cloud/bin/start-fulltextsearchlive"
stop program "/home/pacs/xyz00/users/cloud/bin/stop-fulltextsearchlive"

= Nextcloud Updates =

== Updater über die Shell starten ==

Wenn die NextCloud sich nicht über das Webfrontend updaten lässt, kann der Updater auch per Shell im directory /updater durch ausführen des updater.phar gestartet werden:

xyz00-cloud@h00:~/nextcloud/updater$ chmod u+x updater.phar
xyz00-cloud@h00:~/nextcloud/updater$ ./updater.phar

Für weitere Informationen kann auf die offizielle Doku ab Ziffer 2. zurückgegriffen werden.

* [https://docs.nextcloud.com/server/latest/admin_manual/maintenance/update.html#using-the-command-line-based-updater https://docs.nextcloud.com]

Wartungsmodus per Shell ein- oder ausschalten:

xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off

== Webfrontend-Updater Probleme / Lösungen ==

=== Datenbank: Indizes | Primärschlüssel | Konvertierungen ===

Aufgetreten nach erfolgtem Versionsupdate Nextcloud 19 auf Nextcloud 20

Nach dem erfolgten Update lädt automatisch die Seite: '''Sicherheits- und Einrichtungswarnungen''' auf dieser wird angemerkt, dass manuelle Schritte für die Datenbank durchzuführen sind. Dies betrifft Indizes, Primärschlüssel und Konvertierungen.

Per Shell in der directory /nextcloud folgende Kommandos ausführen:

xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-indices
xyz00-cloud@h00:~/nextcloud$ php occ db:add-missing-primary-keys
xyz00-cloud@h00:~/nextcloud$ php occ db:convert-filecache-bigint

Wichtig ist hier dem durch Nextcloud angegebenen Kommando ein '''php''' voranzustellen.

== Update per Skript ==

Es ist möglich die regelmäßigen Updates weitgehend zu automatisieren. Ein Skript wäre etwa:

#!/bin/bash
if [ -f $HOME/nextcloud/occ ]; then
echo "Nextcloud Update";
cd $HOME/nextcloud;
php updater/updater.phar -vv --no-backup --no-interaction
php occ maintenance:mode --on
php occ db:add-missing-primary-keys --no-interaction
php occ db:add-missing-columns --no-interaction
php occ db:add-missing-indices --no-interaction
php occ db:convert-filecache-bigint --no-interaction
php occ app:update --all
php occ maintenance:mode --off
else
echo "Keine Nextcloud Installation gefunden";
fi

= Daten auf HDD Storage =
== Einrichtung des HDD Storage ==

Um den langsameren aber günstigeren HDD Storage von Hostsharing zu nutzen, kann das data Verzeichnis von SSD auf HDD Storage verschoben werden. Über einen symbolischen Link findet Nextcloud das Verzeichnis auch weiterhin. Zur Sicherheit kann man auch den Pfad in der Nextcloud Konfigurationsdatei anpassen.

# Nextcloud in Wartungsmodus versetzen
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --on
# Daten auf HDD Storage verschieben
xyz00-cloud@h00:~/nextcloud$ mv data /home/storage/xyz00/users/cloud/
# symbolischen Link anlegen
xyz00-cloud@h00:~/nextcloud$ ln -s /home/storage/xyz00/users/cloud/data data
# Pfad in config.php ändern
nano config/config.php
# Die Zeile mit 'datadirectory' finden und entsprechend ändern:
# 'datadirectory' => '/home/pacs/xyz00/users/cloud/data',
# Wartungsmodus beenden
xyz00-cloud@h00:~/nextcloud$ php occ maintenance:mode --off

= weiterführende Links =

* [https://docs.nextcloud.com/ Nextcloud Dokumentation]
* [https://apps.nextcloud.com/ Nextcloud Erweiterungen ("Apps")]
* [https://ownyourbits.com/2019/06/29/understanding-and-improving-nextcloud-previews/ Optimierung des Caches für Previews]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:CalDAV]]

Roundup

2019-09-07T08:25:02Z

Mih17-bernhard: /* Menüpunkt für "Erledigte" Aufgaben ergänzen */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die eigene "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind):
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe nachfolgender Abschnitt) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http(s)://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Nachdem man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(-ssl)/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi(-ssl)/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi(-ssl) für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.7/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(ssl)/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">erledigte anzeigen</a><br>

TODO: Kann jemand an dieser Stelle beschreiben wie man den Text unter Berücksichtigung der Internationalisierung angibt.

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T08:22:54Z

Mih17-bernhard: /* Menüpunkt für "Erledigte" Aufgaben ergänzen */

Roundup

2019-09-07T08:17:46Z

Mih17-bernhard: /* .htaccess-Datei für cgi konfigurieren */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die eigene "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind):
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe nachfolgender Abschnitt) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http(s)://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Nachdem man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(-ssl)/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi(-ssl)/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi(-ssl) für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.7/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(ssl)/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T08:17:19Z

Mih17-bernhard: /* WSGI-Interface einbinden */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die eigene "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind):
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe nachfolgender Abschnitt) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http(s)://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Nachdem man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(-ssl)/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi(-ssl)/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi(-ssl) für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.7/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T08:16:04Z

Mih17-bernhard: /* Subdomain anlegen */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die eigene "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind):
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe nachfolgender Abschnitt) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http(s)://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Nachdem man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs(-ssl)/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi(-ssl)/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi-bin für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.5/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T08:14:56Z

Mih17-bernhard: /* Installation eines neuen Trackers */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die eigene "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind):
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe nachfolgender Abschnitt) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http(s)://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Nachdem man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi-bin für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.5/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T08:09:28Z

Mih17-bernhard: /* Installation eines neuen Trackers */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

"tracker home" bezeichnet dabei ein Verzeichnis das man zuvor in seinem Home angelegt hat. Man kann auch mehrere Tracker-Instanzen parallel betreiben, die ein jeder sein eigenes "tracker home" bekommen.
Beispiel: ~/roundup-tracker-projects/my-first-tracker

Beim Betrieb mit Mysql (um Backups zu ermöglichen die sicher konsistent sind)
* bei "Select backend" mysql angeben
* mit hsadmin einen DB-User erzeugen
* mit hsadmin eine DB erzeugen und den DB-User zuweisen
* DB, DB-User und Passwort des DB-Users sowie localhost als host (siehe weiter unten) in config.ini in der Sektion rdbms angeben.

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

Falls man sich für ein RDBMS-Backend als Datenbank entscheidet, sollte man sicherheitshalber auch Benutzername und Passwort für die Datenbank ändern

user = '''DBBENUTZERNAME'''
password = '''DBPASSWORT'''

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Wenn man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi-bin für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.5/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]

Roundup

2019-09-07T07:55:23Z

Mih17-bernhard: /* Neueste Quellen per Mercurial besorgen */

== Installation roundup issue tracker (cgi-bin) ==

Die allgemeine Installationsanleitung für roundup findet man unter http://roundup-tracker.org/docs/installation.html

Im Folgenden soll die Installation bei Hostsharing in einem WEB-Paket im cgi-bin einer Domain '''ohne eigene httpd.conf''' beschrieben werden.
Das Beispiel beschreibt die nötigen Schritte für den Domain-Admin innerhalb des WEB-Paketes.

=== Neueste Quellen per Mercurial besorgen ===

hg clone http://hg.code.sf.net/p/roundup/code /home/pacs/xyz00/users/USERNAME/roundup

=== Installation der tracker-Software ===

python setup.py install --prefix=/home/pacs/xyz00/users/USERNAME/roundup/install --install-scripts=/home/pacs/xyz00/users/USERNAME/roundup/bin

=== Anpassen der Umgebungsvariablen ===

In der bash-Umgebung:

export PATH=$PATH:/home/pacs/xyz00/users/USERNAME/roundup/bin
export PYTHONPATH=$PYTHONPATH:/home/pacs/xyz00/users/USERNAME/roundup/install/lib/python2.5/site-packages/

Am besten trägt man diese beiden Zeilen in der Datei <code>.bash_profile</code> ein, dann stehen die Pfade beim starten der Shell direkt zur Verfügung:

nano ~/.bash_profile

=== Installation eines neuen Trackers ===

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin install

bzw.

roundup-admin install

(Wenn man die Umgebungsvariablen wie im Abschnitt zuvor beschrieben konfiguriert hat.)

Dabei werden folgende Eingaben abgefragt (Eingaben nur beispielhaft):

Enter tracker home: '''/pfad/zum/tracker/home'''
Templates: minimal, classic
Select template [classic]: '''classic'''
Back ends: anydbm, mysql, sqlite, postgresql
Select backend [anydbm]: '''sqlite'''

==== Tracker anpassen ====

nano /home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/config.ini

Hier müssen zumindest diese Variablen angepasst werden:

admin_email = mail@example.com
dispatcher_email = mail@example.com
name = TRACKERBESCHREIBUNG
web = http://SUBDOMAIN.example.com/
email = mail@example.com
domain = example.com
host = localhost

Optional kann man das logging in eine Datei aktivieren:

filename = /home/pacs/xyz00/users/USERNAME/TRACKERNAME.log

Falls man sich für ein RDBMS-Backend als Datenbank entscheidet, sollte man sicherheitshalber auch Benutzername und Passwort für die Datenbank ändern

user = '''DBBENUTZERNAME'''
password = '''DBPASSWORT'''

==== Datenbank initialisieren ====

/home/pacs/xyz00/users/USERNAME/roundup/bin/roundup-admin initialise

bzw.

roundup-admin initialise

(Wenn man die Umgebungsvariablen wie oben beschrieben konfiguriert hat.)

=== Subdomain anlegen ===

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN</code>

Ein eigenes cgi-verzeichnis für die neue subdomain:

<code>mkdir /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN</code>

=== Konfiguration '''mit''' eigener httpd.conf ===

'''!! Dieser Abschnitt ist mangels eigener httpd.conf ungetestet !!'''

==== cgi-frontend kopieren ====

cp /home/pacs/xyz00/users/USERNAME/roundup/frontends/roundup.cgi /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/

==== cgi-frontend anpassen ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/cgi/SUBDOMAIN/roundup.cgi</code>
TRACKER_HOMES = {
'TRACKERNAME': '/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME',
}

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup.cgi/$1

'''!! ENDE ungetester Abschnitt !!'''

=== Konfiguration '''ohne''' eigene httpd.conf ===

==== WSGI-Interface einbinden ====

Ohne eigene httpd.conf benötigt man einen Wrapper (s. [[Flup]]).

Dies legt man in seinem cgi-bin für die subdomain als <code>roundup_stub</code> ab:

#!/usr/bin/env python
import sys
sys.path.append("/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/install/lib/python2.5/site-packages")
from flup.server.cgi import WSGIServer
# obtain the WSGI request dispatcher
from roundup.cgi.wsgi_handler import RequestDispatcher
tracker_home = '/home/pacs/'''xyz00'''/users/'''USERNAME'''/roundup/tracker/'''TRACKERNAME''''
app = RequestDispatcher(tracker_home)
WSGIServer(app).run()

Die '''hervorgehobenen Stellen''' sind an die eigenen Gegebenheiten anzupassen.

Anschließend muss man den Wrapper ausführbar machen:

chmod 755 roundup_stub

Wenn es Fehlern kommt, kann man debugging-Meldungen an den Browser ausgeben lassen. Dazu ergänzt man unter der Zeile "sys.path.append..."

import cgitb
cgitb.enable()

==== .htaccess-Datei für cgi konfigurieren ====

<code>nano /home/pacs/xyz00/users/USERNAME/doms/example.com/subs/SUBDOMAIN/.htaccess</code>

RewriteEngine On
RewriteBase /
RewriteRule ^(.*) /cgi-bin/SUBDOMAIN/roundup_stub/$1

== Individualisierung der tracker ==

Die Tracker kann man individuell an die eigenen Wünsche anpassen.

Das Datenbank-Schema liegt z.B. unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/schema.py

Die Datenbank-Initialisierungs-Datei liegt unter
/home/pacs/xyz00/users/USERNAME/tracker/TRACKERNAME/initial_data.py

Zum Übernehmen der Änderungen an der Datenbank muss man die Datenbank neu initialisieren. '''Achtung: Dabei gehen alle Daten in der DB verloren!'''

roundup-admin initialise

Details zur Individualisierung nennt die Unterseite "Docs" -> "Customising Roundup" (http://roundup-tracker.org/docs/customizing.html).

=== Registrieren verhindern ===

Um nur manuell ergänzte Benutzer zuzulassen, muss man der Rolle Anonymous das Recht "Register" nehmen. Das bewerkstelligt man durch auskommentieren der letzten Zeile in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register
db.security.addPermissionToRole('Anonymous', 'Register', 'user')

=== Anzeige der issues nur für eingeloggte Benutzer ===

Damit nur eingeloggte Benutzer die issues (Aufgaben) sehen können, muss man der Rolle Anonymous das Recht "View" nehmen. Das bewerkstelligt man durch auskommentieren der letzten beiden Zeilen in diesem Abschnitt der datei <code>/home/pacs/xyz00/users/USERNAME/roundup/tracker/TRACKERNAME/schema.py</code>

# Allow anonymous users access to view issues (and the related, linked
# information)
for cl in 'issue', 'file', 'msg', 'keyword', 'priority', 'status':
db.security.addPermissionToRole('Anonymous', 'View', cl)

=== Logo einfügen ===

In der linken oberen Ecke ist Platz für ein eigenes Logo oder eine Überschrift.

[[Datei:Roundup_main.jpg]]

Bearbeitet werden muss die Datei

/pfad/zum/tracker/html/page.html

in der Tabellenzelle

<td class="page-header-left"><code>&nbsp;</code></td>

Wenn ein Logo mit einem Link hinterlegt wird, erscheint standardmäßig ein blauer Rahmen um die Grafik. Das kann unerwünscht sein. Unterdrücken kann man diesen Rahmen mit dem Zusatz

a img
{
border: none;
}

in der Datei

/pfad/zum/tracker/html/style.css

=== Kategorien farblich absetzen ===

Damit die Priorität etwas hervorsticht, kann man die Kategorien farblich absetzen. Es bietet sich an, eine Legende vor und hinter der Aufgaben (issue) Liste einzufügen. Wir formatieren die Legende später per CSS, daher geben wir ihr auch eine CSS-Klasse mit.

<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>

Dies bewerkstelligt man in der Datei

/pfad/zum/tracker/html/issue.index.html

an den Stellen

<tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="list">
<tr>
(= über der Aufgaben-Liste)

und

</metal:index>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a>
(= unter der Aufgaben-Liste)

Der fertige Abschnitt '''über''' der Aufgaben-Liste sieht dann so aus:

<code><tal:block tal:define="batch request/batch" tal:condition="context/is_view_ok">
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<table class="list">
<tr></code>

Der fertige Abschnitt '''unter''' der Aufgaben-Liste sieht dann so aus:

<code> </metal:index>
</table>
<table class="color-reference">
<tr>
<td>Legende:</td>
<td class="priority-critical" i18n:translate="">critical</td>
<td class="priority-urgent" i18n:translate="">urgent</td>
<td class="priority-bug" i18n:translate="">bug</td>
<td class="priority-feature" i18n:translate="">feature</td>
<td class="priority-wish" i18n:translate="">wish</td>
</tr>
</table>
<a tal:attributes="href python:request.indexargs_url('issue',
{'@action':'export_csv'})" i18n:translate="">Download as CSV</a></code>

Damit auch die Aufgaben in der entsprechenden Farbe erscheinen, passt man noch die Datei

/pfad/zum/tracker/html/issue.index.html

an. Die Zeilen

<tr>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

ändert man in

<tr''' tal:attributes="class string:priority-${i/priority/plain}"'''>
<td tal:condition="request/show/priority"
tal:content="python:i.priority.plain() or default"> </td>

Zum Schluss muss man noch die CSS-Formatierungen ergänzen in der Datei

/pfad/zum/tracker/html/style.css

Hier ist z.B. ein solcher Block einzufügen:

tr.priority-critical td, .priority-critical
{
background-color: #FF8989;
color: #ffffff;
}
tr.priority-critical td a:link
{
color: #ffffff;
font-weight: bold;
}
tr.priority-urgent td, .priority-urgent
{
background-color: #FFD089;
}
tr.priority-bug td, .priority-bug
{
background-color: #FFFE89
}
tr.priority-feature td, .priority-feature
{
background-color: #C0DDFF;
}
tr.priority-wish td, .priority-wish
{
background-color: #C0FFCC;
}
table.color-reference
{
margin-top: 10px;
margin-bottom: 30px;
}
.color-reference td
{
width: 100px;
text-align: center;
font-weight: bold;
border: 1px solid #ababab;
}

Das Ergebnis sieht so aus:

[[Datei:Roundup_legende.jpg]]

=== Menüpunkt für "Erledigte" Aufgaben ergänzen ===

In der Datei

/pfad/zum/tracker/html/page.html

ist diese Textstelle

status_notresolved string:-1,1,2,3,4,5,6,7;

um eine Zeile zu erweitern:

status_notresolved string:-1,1,2,3,4,5,6,7;
'''status_resolved string:8;'''

Außerdem ist noch

i18n:translate="">Show All</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

zu ersetzen durch:

i18n:translate="">Show All</a><br>
<a href="#"
tal:attributes="href python:request.indexargs_url('issue', {
'@sort': '-activity',
'@group': 'priority',
'@filter': 'status',
'@columns': columns_showall,
'@search_text': '',
'status': status_resolved,
'@dispname': i18n.gettext('Erledigte anzeigen'),
})"
i18n:translate="">Erledigte anzeigen</a><br>
<a href="issue?@template=search" i18n:translate="">Search</a><br>

Das Ergebnis:

[[Datei:Roundup_erledigte.png]]

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Glossar]]
[[Kategorie:Software]]