Changeset 998

Show
Ignore:
Timestamp:
01/30/09 10:34:10 (3 years ago)
Author:
hovenko
Message:

Translated the user and system documentation from Norwegian to English

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/doc/systemdoc/en/configuration.tex

    r919 r998  
    1 \chapter{Konfigurasjon} 
    2  
    3 Det er flere deler av Bifrost-lÞsningen som mÃ¥ konfigureres. Det meste er kort forklart i \texttt{INSTALL}-dokumentet som ligger pÃ¥ roten av prosjektkatalogen
    4 I dette kapittelet presenteres konfigurasjonsfilene for CUPS Backend-drivere og Bifrost Backend. 
     1\chapter{Configuration} 
     2 
     3A number of aspects of Bifrost need to be configured. Most of this is explained in the \texttt{INSTALL} document on the project catalog root
     4This chapter describes the configuration files for the CUPS Back-end drivers and Bifrost Back-end. 
    55 
    66 
    77\section{CUPS Backend} 
    8  
    9 Ta utgangspunkt i konfigurasjonsfilen som ligger under \texttt{src/CUPS/followme.yml}. 
    10 Konfigurasjonsfilen forventes Ã¥ ligge under rotkatalogen til CUPS, som i de fleste tilfeller er \texttt{/etc/cups/}, og heter \textbf{followme.yml}. 
    11 Denne konfigurasjonsfilen er skrevet i YAML. 
    12 BÃ¥de ``followme''- og ``route''-backend benytter seg av samme konfigurasjonsfilen. 
     8Start with the configuration file under \texttt{src/CUPS/followme.yml}. 
     9The configuration file is expected to reside under the CUPS root catalog, usually \texttt{/etc/cups/}, and is called \textbf{followme.yml}  
     10This configuration file is written in YAML. 
     11Both the ``followme'' and ``route'' back-end use the same configuration file. 
    1312 
    1413\subsection{followme} 
    15 Konfigurasjon for backend-driveren ``followme''
     14Configuring the ``followme'' back-end driver
    1615 
    1716\subsubsection{URL\_BASE} 
    18 Basis for URL til Bifrost backend
    19 Denne vil trolig mÃ¥tte settes til en ny verdi, da den ellers tilbakefaller til ``http://localhost:3000''. 
    20 Dersom applikasjonen er satt opp pÃ¥ rota med for eksempel Apache og FastCGI mÃ¥ denne konfigurasjonsparameteren settes til ``http://localhost''. 
     17Basis for the Bifrost back-end URL
     18Usually, you will have to set a new value, so it doesn't fall back to ``http://localhost:3000''. 
     19If the application is set up on the root with e.g. Apache and FastCGI, this configuration parameter must be set to ``http://localhost''. 
    2120 
    2221\subsubsection{URL\_UPDATE\_QUOTA} 
    23 Absolutt URL til Bifrost backend for oppdatering av kvote
    24 Denne vil tilbakefalle pÃ¥ ``/backend/cups/decrement\_quota'', prefikset med ``URL\_BASE''
     22Absolute URL for the Bifrost back-end for updating quotas
     23This will fall back to ``/backend/cups/decrement\_quota'', with a ``URL\_BASE'' prefix
    2524 
    2625\subsubsection{URL\_ENOUGH\_QUOTA} 
    27 Absolutt URL til Bifrost backend for sjekking av brukerens kvote
    28 Denne vil tilbakefalle pÃ¥ ``/backend/cups/enough\_quota'', prefikset med ``URL\_BASE''
     26Absolute URL for the Bifrost back-end for checking user quotas
     27This will fall back to ``/backend/cups/enough\_quota'', with a ``URL\_BASE'' prefix
    2928 
    3029\subsubsection{URL\_REPORT\_ERROR} 
    31 Absolutt URL til Bifrost backend for rapportering av feil
    32 Denne vil tilbakefalle pÃ¥ ``/backend/cups/error'', prefikset med ``URL\_BASE''
     30Absolute URL for the Bifrost back-end for error reports
     31This will fall back to ``/backend/cups/error'', with a ``URL\_BASE'' prefix
    3332 
    3433\subsubsection{USER\_AGENT} 
    35 Navnet pÃ¥ brukeragenten som kaller pÃ¥ Bifrost backend. 
    36 Denne vil tilbakefalle pÃ¥ ``Bifrost CUPS Backend''. 
    37 Denne behÞver du ikke endre, ved mindre du har spesielle behov med tanke pÃ¥ for eksempel traversering igjennom proxy-tjenester eller logging av trafikk basert pÃ¥ agent
     34The name of the user agent that calls the Bifrost back-end. 
     35This will fall back to ``Bifrost CUPS Backend''. 
     36You do not need to modify this, unless you have specific needs for e.g. traversing through proxy services or agent-based traffic logging
    3837 
    3938\subsubsection{TIMEOUT} 
    40 Antall sekunder Ã¥ maksimalt vente fÞr en HTTP request mot Bifrost backend avbrytes
    41 Denne vil tilbakefalle pÃ¥ ``15'' sekunder
     39The maximum number of seconds to wait before a HTTP request against Bifrost back-end is canceled
     40This will fall back to ``15'' seconds
    4241 
    4342\subsubsection{DEBUG} 
    44 Settes til en \textbf{SANN} verdi for Ã¥ skru pÃ¥ debugging. 
    45 Denne vil tilbakefalle til en \textbf{USANN} verdi, som skrur av debugging. 
     43Set to a \textbf{TRUE} value for enabling debugging. 
     44This will fall back to a \textbf{FALSE} value, disabling debugging. 
     45 
    4646 
    4747\begin{verbatim} 
    4848--- 
    49 BASE_URL:           "http://localhost:3000" 
    50 URL_UPDATE_QUOTA: "http://localhost:3000/backend/cups/decrement_quota" 
    51 URL_ENOUGH_QUOTA: "http://localhost:3000/backend/cups/enough_quota" 
    52 URL_REPORT_ERROR: "http://localhost:3000/backend/cups/error" 
    53 USER_AGENT:         "Bifrost CUPS Backend" 
    54 TIMEOUT:            15 
    55 DEBUG:              
     49BASE_URL:           "http://localhost:3000" 
     50URL_UPDATE_QUOTA:   "http://localhost:3000/backend/cups/decrement_quota" 
     51URL_ENOUGH_QUOTA:   "http://localhost:3000/backend/cups/enough_quota" 
     52URL_REPORT_ERROR:   "http://localhost:3000/backend/cups/error" 
     53USER_AGENT:         "Bifrost CUPS Backend" 
     54TIMEOUT:            15 
     55DEBUG:              
    5656\end{verbatim} 
    5757 
    5858 
    5959\subsection{route} 
    60 Konfigurasjon for backend-driveren ``route''
     60Configuration of the ``route'' back-end driver
    6161 
    6262\subsubsection{LPR} 
    63 Full sti til programmet \textbf{lpr} som brukes for utskrift
     63Complete path to the \textbf{lpr} application used for printing
    6464 
    6565\subsubsection{DEBUG} 
    66 Settes til en \textbf{SANN} verdi for Ã¥ skru pÃ¥ debugging. 
    67 Denne vil tilbakefalle til en \textbf{USANN} verdi, som skrur av debugging. 
     66Set to a \textbf{TRUE} value to enable debugging. 
     67This will fall back to a \textbf{FALSE} value, disabling debugging. 
    6868 
    6969\begin{verbatim} 
    7070--- 
    71 LPR:                "/usr/bin/lpr" 
    72 DEBUG:              
    73 \end{verbatim} 
    74  
    75  
    76 \section{Bifrost Backend} 
    77  
    78 Ta utgangspunkt i konfigurasjonsfilen som ligger under \texttt{src/Followme/followme.yml}. 
    79 Konfigurasjonsfilen forventes Ã¥ ligge under roten hvor Bifrost backend ble installert, for eksempel \texttt{/usr/local/followme/}. 
    80 Denne konfigurasjonsfilen er skrevet i YAML. 
    81  
    82 Noen konfigurasjonsparametere kan vÊre unnlatt Ã¥ nevne her\footnote{Det er Þnskelig Ã¥ gjÞre dokumentasjon mer komplett, vennligst meld i fra dersom noe mer bÞr inn her}. 
    83 Det henvises derfor til \textbf{POD} i de forskjellige modulene som kan leses med \textbf{perldoc}. 
    84  
    85 \subsection{Autentisering
     71LPR:                "/usr/bin/lpr" 
     72DEBUG:              
     73\end{verbatim} 
     74 
     75 
     76\section{Bifrost Back-end} 
     77 
     78Start with the configuration file under \texttt{src/Followme/followme.yml}. 
     79The configuration file is expected to reside under the root where the Bifrost back-end was installed, for instance \texttt{/usr/local/followme/}. 
     80This configuration file is written in YAML. 
     81 
     82Certain configuration parameters may have been left out here\footnote{We wish to make the documentation as complete as possible; please notify us of suggested additions}. 
     83Please refer to \textbf{POD} in the respective modules, readable with \textbf{perldoc}. 
     84 
     85\subsection{Authentication
    8686\label{configuration-authentication} 
    87 Bifrost er konfigurert til Ã¥ autentisere mot LDAP. 
    88 Det er slik at brukere og administratorer er lagt i to forskjellige grener i LDAP-treet, og derfor er det konfigurert opp to realms, én for brukere og én for administrasjonen
    89  
    90 Autentisering er konfigurert under parameteren \textbf{autentication} i konfigurasjonsfilen
    91 GjÞr nÞdvendige endringer for ditt miljÞ, som \textbf{ldap\_server} og \textbf{user\_basedn} 
    92 Konfigurasjon av denne parameteren er forklart i Perl-modulen \textbf{Catalyst::Plugin::Authentication}\footnote{http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication}
     87Bifrost is configured to authenticate against LDAP. 
     88Users and administrators are placed in two different branches of the LDAP tree. As a consequence, two realms have been configured; one for users and another for administrators
     89 
     90Authentication is configured under the \textbf{authentication} parameter in the configuration file
     91Make the appropriate modifications for your environment, such as \textbf{ldap\_server} and \textbf{user\_basedn} 
     92Configuration of this parameter is described in the \textbf{Catalyst::Plugin::Authentication}\footnote{http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication} Perl module
    9393 
    9494\subsubsection{store - roles} 
    95 Konfigurasjonsparameteren \textbf{roles} inneholder en liste over roller/grupper som brukere i valgt realm tildeles
    96 I Bifrost skiller vi bare pÃ¥ vanlige brukere (user) og administrasjonsbrukere (admin). 
    97  
    98 Denne konfigurasjonsparameteren benyttes av modulen \textbf{Followme::Authentication::Store::LDAP}, som er en utvidelse av standardmodulen til Catalyst for autentisering mot LDAP\footnote{http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication::Store::LDAP}. 
     95The \textbf{Roles} configuration parameter contains a list of roles/groups that are assigned to users in the selected realm
     96Bifrost only distinguishes between ordinary users (user) and administrator users (admin). 
     97 
     98This configuration parameter is used by the \textbf{Followme::Authentication::Store::LDAP} module, which is an extension of the default Catalyst module for authentication against LDAP\footnote{http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication::Store::LDAP}. 
    9999 
    100100\begin{verbatim} 
    101101authentication: 
    102   default_realm:  users 
    103  realms: 
    104     users: 
    105       credential: 
    106         class:          Password 
    107         password_field: password 
    108         password_type:  self_check 
    109       store: 
    110         class:          '+Followme::Authentication::Store::LDAP' 
    111         ldap_server:    "ldap://followme.lab.linpro.no" 
    112         start_tls:     
    113         user_basedn:    "ou=people,dc=mrvgs,dc=no" 
    114         user_filter:    "( &(objectClass=posixAccount)(uid=%s) )" 
    115         user_scope:    one 
    116         user_field:    uid 
    117         user_search_options: 
    118           deref:          always 
    119         roles: 
    120           -  user 
    121     admins: 
    122       credential: 
    123         class:          Password 
    124         password_field: password 
    125         password_type:  self_check 
    126       store: 
    127         class:          '+Followme::Authentication::Store::LDAP' 
    128         ldap_server:    "ldap://followme.lab.linpro.no" 
    129         start_tls:     
    130         user_basedn:    "ou=ansatt,dc=mrvgs,dc=no" 
    131         user_filter:    "( &(objectClass=posixAccount)(uid=%s) )" 
    132         user_scope:    one 
    133         user_field:    uid 
    134         user_search_options: 
    135           deref:          always 
    136         roles: 
    137           -  admin 
    138 \end{verbatim} 
    139  
    140  
    141 \subsubsection{Brukere i samme gren
    142 Dersom vanlige brukere og administrasjonsbrukere finnes i samme gren i LDAP-treet og er delt inn i grupper kan fÞlgende konfigurasjon benyttes under \textbf{authentication}: 
     102  default_realm:  users 
     103  realms: 
     104    users: 
     105      credential: 
     106        class:          Password 
     107        password_field: password 
     108        password_type:  self_check 
     109      store: 
     110        class:          '+Followme::Authentication::Store::LDAP' 
     111        ldap_server:    "ldap://followme.lab.linpro.no" 
     112        start_tls:      
     113        user_basedn:    "ou=people,dc=mrvgs,dc=no" 
     114        user_filter:    "( &(objectClass=posixAccount)(uid=%s) )" 
     115        user_scope:     one 
     116        user_field:     uid 
     117        user_search_options: 
     118          deref:          always 
     119        roles: 
     120          -   user 
     121    admins: 
     122      credential: 
     123        class:          Password 
     124        password_field: password 
     125        password_type:  self_check 
     126      store: 
     127        class:          '+Followme::Authentication::Store::LDAP' 
     128        ldap_server:    "ldap://followme.lab.linpro.no" 
     129        start_tls:      
     130        user_basedn:    "ou=ansatt,dc=mrvgs,dc=no" 
     131        user_filter:    "( &(objectClass=posixAccount)(uid=%s) )" 
     132        user_scope:     one 
     133        user_field:     uid 
     134        user_search_options: 
     135          deref:          always 
     136        roles: 
     137          -   admin 
     138\end{verbatim} 
     139 
     140 
     141\subsubsection{Users in the same branch
     142If ordinary users and administrator users reside in the same LDAP tree branch, and are grouped, the following configuration can be used under \textbf{authentication}: 
    143143 
    144144\begin{verbatim} 
    145145default_realm: ldap 
    146146realms: 
    147  ldap: 
    148     credential: 
    149       class:          Password 
    150       password_field: password 
    151       password_type:  self_check 
    152     store: 
    153       class:          LDAP 
    154       ldap_server:    "ldap://localhost" 
    155       start_tls:     
    156       user_basedn:    "ou=people,dc=mrvgs,dc=no" 
    157       user_filter:    "( &(objectClass=person)(uid=%s) )" 
    158       user_scope:    one 
    159       user_field:    uid 
    160       user_search_options: 
    161         deref:          always 
    162       use_roles:     
    163       role_basedn:    "ou=groups,dc=mrvgs,dc=no" 
    164       role_filter:    "( &(objectClass=posixGroup)(memberUid=%s) )" 
    165       role_scope:    one 
    166       role_field:    cn 
    167       role_value:    uid 
    168       role_search_options: 
    169         deref:          always 
    170 \end{verbatim} 
    171  
    172 Bemerk at modulen \textbf{Followme::Authentication::Store::LDAP} ikke lenger brukes, men heller \textbf{LDAP}. 
    173  
    174  
    175 \subsubsection{Administratorbrukere i konfigurasjonsfilen
    176 Dersom man Þnsker et enklere oppsett over administratorbrukere i Bifrost kan man konfigurere opp brukernavn og passord i followme.yml: 
    177  
    178 FÞlgende konfigurasjon setter opp en administrator som heter ``superadmin'' med passordet ``hemmelig''
     147  ldap: 
     148    credential: 
     149      class:          Password 
     150      password_field: password 
     151      password_type:  self_check 
     152    store: 
     153      class:          LDAP 
     154      ldap_server:    "ldap://localhost" 
     155      start_tls:      
     156      user_basedn:    "ou=people,dc=mrvgs,dc=no" 
     157      user_filter:    "( &(objectClass=person)(uid=%s) )" 
     158      user_scope:     one 
     159      user_field:     uid 
     160      user_search_options: 
     161        deref:          always 
     162      use_roles:      
     163      role_basedn:    "ou=groups,dc=mrvgs,dc=no" 
     164      role_filter:    "( &(objectClass=posixGroup)(memberUid=%s) )" 
     165      role_scope:     one 
     166      role_field:     cn 
     167      role_value:     uid 
     168      role_search_options: 
     169        deref:          always 
     170\end{verbatim} 
     171 
     172Please note that the \textbf{Followme::Authentication::Store::LDAP} module is no longer used; instead use \textbf{LDAP}. 
     173 
     174 
     175\subsubsection{Administrator users in the configuration file
     176If you want a simpler setup for Bifrost administrator users, you can configure user names and passwords in followme.yml: 
     177 
     178The following configuration defines an administrator called ``superadmin'' with ``secret'' as his password
    179179 
    180180\begin{verbatim} 
    181181realms: 
    182  admins: 
    183     credential: 
    184       class:          Password 
    185       password_field: password 
    186       password_type:  clear 
    187  store: 
    188     class:          Minimal 
    189     users: 
    190       superadmin: 
    191         password:   hemmelig 
    192         roles: 
    193           -  admin 
     182  admins: 
     183    credential: 
     184      class:          Password 
     185      password_field: password 
     186      password_type:  clear 
     187  store: 
     188    class:          Minimal 
     189    users: 
     190      superadmin: 
     191        password:   secret 
     192        roles: 
     193          -   admin 
    194194\end{verbatim} 
    195195 
    196196 
    197197\subsection{Realms} 
    198 Her spesifiserer man hvilke realms, eller grupperinger av brukere, som det er mulig Ã¥ velge mellom. 
    199 Fordi denne modulen ble laget som en ``workaround'' for Ã¥ stÞtte opp under oppdelingen av brukere og administrasjonsbrukere i forskjellige grener i LDAP-treet, er det ikke mulig Ã¥ endre pÃ¥ denne konfigurasjonen for Ã¥ legge til flere realms. 
    200 Dette fordi malfilene for nettsidene kun stÞtter ``admins'' i tillegg til ``default'', som i vÃ¥rt tilfelle er ``users''. 
     198 
     199This is where you specify the available realms, or user groups. Since this module was developed as a ``workaround'' to support the split of users and administrator users into separate branches on the LDAP tree, it is not possible modify this configuration in order to add more realms. 
     200The template files for web pages only support ``admins'' in addition to ``default'', which in our case equals ``users''. 
    201201 
    202202\subsubsection{realms} 
    203 En nÞkkel/verdi-liste over realms. 
    204 NÞkkelen mÃ¥ matche mot realms definert i \textbf{authentication} (se seksjon \ref{configuration-authentication}). 
    205 Verdien er et menneskevennlig navn pÃ¥ realmet
     203A key/value list of realms. 
     204The key needs to match realms defined in \textbf{authentication} (see section \ref{configuration-authentication}). 
     205The value is a user-friendly name of the realm
    206206 
    207207\begin{verbatim} 
    208208Model::Realms: 
    209  realms: 
    210     admins: Administration 
    211     users:  Users 
    212 \end{verbatim} 
    213  
    214  
    215 \subsection{E-postadresser
    216 Konfigurasjon av e-postadresser og -utsending gjÞres under parameteren \textbf{Model::Email}
     209  realms: 
     210    admins: Administration 
     211    users:  Users 
     212\end{verbatim} 
     213 
     214 
     215\subsection{E-mail addresses
     216Configure e-mail addresses and e-mail submission under the \textbf{Model::Email} parameter
    217217 
    218218\subsubsection{admin} 
    219 Dette er e-postadressen til systemadministrator. Denne e-posten vil motta kopi av feilmeldinger som sendes ut til brukere
     219This is the system administrator's e-mail address, which receives copies of error messages to users
    220220 
    221221\subsubsection{from} 
    222 Dette er e-postadressen som stÃ¥r som avsender pÃ¥ e-post som sendes ut fra Bifrost. 
     222This is the e-mail address displayed as sender of e-mail messages from Bifrost. 
    223223 
    224224\subsubsection{default\_locales} 
    225 Dette er det forhÃ¥ndsvalgte sprÃ¥ket for e-post som sendes ut dersom klienten som meldte fra om feilen ikke har spesifisert hvilket sprÃ¥k som skal benyttes
    226 Dette kan vÊre navnet pÃ¥ sprÃ¥ket eller en liste med navn
     225This is the pre-selected language for e-mail messages submitted if the client who reported the error has not specified which language to use
     226This could be the name of the language or a list of names
    227227 
    228228\subsubsection{user\_fmt} 
    229 Dette er formatstrengen som brukes for Ã¥ finne fram til brukernes e-postadresser
    230 \textbf{\%s} byttes ut med brukernavnet til brukeren
    231 Alle brukere mÃ¥ kunne nÃ¥s pÃ¥ samme domenenavn. 
     229This is the format string used for finding the users' e-mail addresses
     230\textbf{\%s} is replaced with the user's user name
     231All users must be reachable on the same domain. 
    232232 
    233233\begin{verbatim} 
    234234Model::Email: 
    235   admin:              'Bifrost Admin <root@localhost>' 
    236   from:              'Bifrost <root@localhost>' 
    237   default_locales:    'no' 
    238   user_fmt:          '%s@localhost' 
    239 \end{verbatim} 
    240  
    241  
    242 \subsection{Administrasjon} 
    243 Konfigurasjonen for administrasjonsgrensesnittet spesifiserer hvilke roller som har tilgang med parameternavnet \textbf{require\_roles}
    244 Dette kan vÊre navnet pÃ¥ rollen eller en liste med rollenavn
    245  
    246 Det anbefales Ã¥ ikke endre pÃ¥ denne
     235  admin:              'Bifrost Admin <root@localhost>' 
     236  from:               'Bifrost <root@localhost>' 
     237  default_locales:    'no' 
     238  user_fmt:           '%s@localhost' 
     239\end{verbatim} 
     240 
     241 
     242\subsection{Administration} 
     243The configuration of the administration interface specifies role access with the \textbf{require\_roles} parameter
     244This could be the name of the role or a list of role names
     245 
     246We recommend that you do not modify this
    247247 
    248248\begin{verbatim} 
    249249Controller::Admin: 
    250  require_roles: admin 
     250  require_roles: admin 
    251251\end{verbatim}  
    252252 
    253253 
    254 \subsection{Tilgangskontroll til backend
    255 Konfigurasjonen for backend spesifiserer hvilke IP-adresser som har tilgang til backend-funksjonaliteten, som Ã¥ sende inn kortdata og melde ifra om feil.   
    256 Realm-et \textbf{cardreaders} bestemmer hvor kortlesere kommer fra
    257 Realm-et \textbf{ez} bestemmer hvor portallÞsninger kan komme fra; disse har anledning til Ã¥ liste ut, legge til og slette jobber og liste ut kvote for brukere
    258  
    259 \subsubsection{Subnett
    260 \textbf{subnets} inneholder en liste over subnett som har tilgang
    261 Disse defineres med nettverksadressen med CIDR-notasjon. 
    262 Det er viktig at localhost (127.0.0.1/8) har tilgang for at CUPS skal kunne sjekke og oppdatere kvoter
     254\subsection{Back-end access control
     255The back-end configuration specifies IP addresses with access to the back-end functionality, for instance submitting card data and reporting errors.   
     256The \textbf{cardreaders} realm decides where card readers come from
     257The \textbf{ez} realm decides where portal solutions can come from; these can list, add and delete print jobs and list user quotas
     258 
     259\subsubsection{Subnet
     260\textbf{subnets} contain a list of subnets with access
     261These are defined with the network address using CIDR notation. 
     262Important: localhost (127.0.0.1/8) must have access in order for CUPS to check and update quotas
    263263 
    264264\begin{verbatim} 
    265265authentication: 
    266     realms: 
    267         cardreaders: 
    268             credential: 
    269                 class:          '+Followme::Authentication::Credential::Exists' 
    270             store: 
    271                 class:          '+Followme::Authentication::Store::Network' 
    272                 subnets: 
    273                    
    274                         network:    "127.0.0.1" 
    275                         cidr:     
    276                    
    277                         network:    "87.238.45.0" 
    278                         cidr:      26 
    279         ez: 
    280             credential: 
    281                 class:          '+Followme::Authentication::Credential::Exists' 
    282             store: 
    283                 class:          '+Followme::Authentication::Store::Network' 
    284                 subnets: 
    285                    
    286                         network:    "87.238.43.90" 
    287                         cidr:      32 
    288                    
    289                         network:    "83.243.223.74" 
    290                         cidr:      32 
    291                    
    292                         network:    "83.243.223.71" 
    293                         cidr:      32 
    294  
    295 \end{verbatim} 
    296  
    297  
    298 \subsection{Kortinnlesing
     266    realms: 
     267        cardreaders: 
     268            credential: 
     269                class:          '+Followme::Authentication::Credential::Exists' 
     270            store: 
     271                class:          '+Followme::Authentication::Store::Network' 
     272                subnets: 
     273                   
     274                        network:    "127.0.0.1" 
     275                        cidr:      
     276                   
     277                        network:    "87.238.45.0" 
     278                        cidr:       26 
     279        ez: 
     280            credential: 
     281                class:          '+Followme::Authentication::Credential::Exists' 
     282            store: 
     283                class:          '+Followme::Authentication::Store::Network' 
     284                subnets: 
     285                   
     286                        network:    "87.238.43.90" 
     287                        cidr:       32 
     288                   
     289                        network:    "83.243.223.74" 
     290                        cidr:       32 
     291                   
     292                        network:    "83.243.223.71" 
     293                        cidr:       32 
     294 
     295\end{verbatim} 
     296 
     297 
     298\subsection{Reading cards
    299299\label{configuration-mac-lookup} 
    300 Det er mulig Ã¥ konfigurere mottaket for kortdata til Ã¥ tillate kortlesere Ã¥ sende sin MAC-adresse som parameter\footnote{MAC-adressen setter med parameternavnet ``macaddress''} sammen med kortdataene
    301  
    302 Bemerk at denne adressen benyttes kun dersom oppslag i ARP-tabellen feiler
     300It is possible to configure the card data reception to allow card readers to submit their MAC addresses a parameter\footnote{the MAC address is set with the ``macaddress'' parameter} together with the card data
     301 
     302Please note that this address is only used if inquiries to the ARP table fail
    303303 
    304304\subsubsection{allow\_mac\_address} 
    305 Settes til en \textbf{SANN} verdi for Ã¥ tillate egenspesifisert MAC-adresse sammen med kortdataene
    306 Bemerk at aktivering av dette kan innebÊre en sikkerhetsrisiko
     305Set to a \textbf{TRUE} value to allow specified MAC address with the card data
     306Please note that activating this option may cause a security risk
    307307 
    308308\begin{verbatim} 
    309309Controller::Backend::Cardreader::Swipe: 
    310   allow_mac_address: 
    311 \end{verbatim} 
    312  
    313  
    314 \subsection{Pinkodeinnlesing} 
    315 Samme konfigurasjon fra kortinnlesing for oppslag av MAC-adresser (se \ref{configuration-mac-lookup}) gjelder ogsÃ¥ for pinkodeinnlesing. 
     310  allow_mac_address:  
     311\end{verbatim} 
     312 
     313 
     314\subsection{Pin code reading} 
     315The configuration of card reading for MAC address inquiries (see \ref{configuration-mac-lookup}) also applies to  pin code reading. 
    316316 
    317317\begin{verbatim} 
    318318Controller::Backend::Numpad::Pincode: 
    319   allow_mac_address: 
     319  allow_mac_address:  
    320320\end{verbatim} 
    321321 
     
    323323\subsection{LDAP} 
    324324\label{configuration-ldap} 
    325 LDAP benyttes som datalager for brukere, kvoter, pinkoder, magnetkort og kortlesere. 
     325 
     326LDAP is used for data storage for users, quotas, pin codes, magnetic cards and card readers. 
    326327 
    327328\subsubsection{host} 
    328 URI til LDAP-tjeneren
    329 Kan vÊre pÃ¥ fÞlgende former
     329URI for the LDAP server
     330This can use the following formats
    330331\begin{itemize} 
    331  \item hostname:port 
    332  \item ldap://hostname:port 
    333  \item ldaps://hostname:port 
    334  \item ldapi://\%2fvar\%2flib\%2fldap\_sock 
     332 \item hostname:port 
     333 \item ldap://hostname:port 
     334 \item ldaps://hostname:port 
     335 \item ldapi://\%2fvar\%2flib\%2fldap\_sock 
    335336\end{itemize} 
    336337 
    337 \textbf{port} settes til standard LDAP-port\footnote{Standard port for LDAP er 389}, dersom den ikke er satt
     338\textbf{port} is set to default LDAP port\footnote{Default LDAP port is 389}, if it hasn't been set already
    338339 
    339340\subsubsection{base} 
    340 Base for sÞk i LDAP-databasen
     341Base for LDAP database searches
    341342 
    342343\subsubsection{dn} 
    343 Navnet pÃ¥ administratorbrukeren i LDAP, med tilgang til Ã¥ opprette og endre pÃ¥ objekter
     344The name of the LDAP administrator user, with access rights to create and modify objects
    344345 
    345346\subsubsection{password} 
    346 Passordet til administratorbrukeren
     347The administrator user password
    347348 
    348349\subsubsection{connection\_class} 
    349 Klassen som brukes for tilkobling til LDAP-tjenesten
    350 Her brukes \textbf{Followme::LDAP::Connection} for Ã¥ stÞtte filtrering basert pÃ¥ en felles verdi blant objektene
     350The class to be used to connect to the LDAP service
     351\textbf{Followme::LDAP::Connection} is used for supporting filtering based on a shared value for the objects
    351352Anbefales Ã¥ ikke endre denne. 
    352353 
    353354\subsubsection{use\_cache} 
    354 En \textbf{SANN} verdi skrur pÃ¥ gjenbruk av LDAP-tilkoblinger
    355 En \textbf{USANN} verdi skrur dette av, som er forhÃ¥ndsvalgt dersom annet ikke er angitt
    356 VÊr oppmerksom pÃ¥ at bruk av cache ikke fjerner tilkoblinger som er tatt ned, enten ved nettverksfeil eller eksplisitte nedkoblinger
     355A \textbf{TRUE} value enables reuse of LDAP connections
     356A \textbf{FALSE} values disables this option; this is the default if nothing else has been specified
     357Please note that reuse of cache does nor remove terminated connections, by network errors or explicit disconnects
    357358 
    358359\subsubsection{user\_filter - field} 
    359 I MÞre og Romsdals tilfelle er filteret satt i \textbf{description}-feltet til brukerne, som forteller hvilken skole ansatte og studenter hÞrer til
     360In the MÞre and Romsdal installation, the filter has been set to the users' \textbf{description} field, displaying the school the student/staff member belongs to
    360361 
    361362\subsubsection{user\_filter - filter} 
    362 Filteret som automatisk legges pÃ¥ hvert sÞk
    363 \textbf{\%s} byttes ut med verdien pÃ¥ feltet satt i \textbf{field} til brukeren som utfÞrer sÞket
    364  
    365 I MÞre og Romsdals filfelle vil brukere uten description-felt blir inkludert i sÞk
    366 SÞk utfÞrt av administrasjonsbrukere uten description-felt gjÞres blant alle brukere
     363The filter automatically assigned to each search
     364\textbf{\%s} is replaced with the value of the field that was set in \textbf{field} of the user performing the search
     365 
     366In the MÞre and Romsdal installation, users with no description will be included in searches
     367Searches performed by administrator users without description fields will include all users
    367368 
    368369\subsubsection{models} 
    369370\label{configuration-ldap-models} 
    370 Modellene som benytter LDAP konfigureres med base og entitetsklasse for sÞk og administrasjon, og eventuelt alternative LDAP-tilkoblingsinnstillinger. 
    371 Anbefales Ã¥ ikke endre \textbf{entry\_class}. 
     371The models using LDAP are configured with base and entity class for search and administration, optionally also alternative LDAP connection settings. 
     372We recommend you not to modify \textbf{entry\_class}. 
     373 
    372374 
    373375\begin{verbatim} 
    374376Model::LDAP: 
    375   host:               "ldap://followme.lab.linpro.no" 
    376   base:               "dc=mrvgs,dc=no" 
    377   dn:                 'cn=admin,dc=mrvgs,dc=no' 
    378   password:           'changeme' 
    379   connection_class:   "Followme::LDAP::Connection" 
    380   use_cache:          0 
    381   user_filter: 
    382     field:      description 
    383     filter:     "( |( !(description=*))(description=%s))" 
    384   models: 
    385     Users: 
    386       base:           'ou=people,dc=mrvgs,dc=no' 
    387       entry_class:    'Followme::LDAP::Entry::User' 
    388     Quota: 
    389       base:           'ou=quota,ou=Bifrost,dc=mrvgs,dc=no' 
    390       entry_class:    'Followme::LDAP::Entry::Quota' 
    391     Cards: 
    392       base:           'ou=cards,ou=identity,ou=Bifrost,dc=mrvgs,dc=no' 
    393       entry_class:    'Followme::LDAP::Entry::Card' 
    394     PinCodes: 
    395       base:           'ou=pincodes,ou=identity,ou=Bifrost,dc=mrvgs,dc=no' 
    396       entry_class:    'Followme::LDAP::Entry::PinCode' 
    397     Cardreaders: 
    398       base:           'ou=cardreaders,ou=Bifrost,dc=mrvgs,dc=no' 
    399       entry_class:    'Followme::LDAP::Entry::Cardreader' 
    400 \end{verbatim} 
    401  
    402  
    403 \subsection{Utskriftskvoter} 
    404 Konfigurasjon for utskriftskvoter. 
    405 Merk at disse konfigurasjonsparametrene kun benyttes ved fÞrstegangs opprettelse av kvoter for brukerne. 
    406 Deretter lagres disse verdiene i brukerens objekt i LDAP. 
    407 Endringer i konfigurasjonen vil dermed bare pÃ¥virke nye brukere. 
     377  host:               "ldap://followme.lab.linpro.no" 
     378  base:               "dc=mrvgs,dc=no" 
     379  dn:                 'cn=admin,dc=mrvgs,dc=no' 
     380  password:           'changeme' 
     381  connection_class:   "Followme::LDAP::Connection" 
     382  use_cache:          0 
     383  user_filter: 
     384    field:      description 
     385    filter:     "( |( !(description=*))(description=%s))" 
     386  models: 
     387    Users: 
     388      base:           'ou=people,dc=mrvgs,dc=no' 
     389      entry_class:    'Followme::LDAP::Entry::User' 
     390    Quota: 
     391      base:           'ou=quota,ou=Bifrost,dc=mrvgs,dc=no' 
     392      entry_class:    'Followme::LDAP::Entry::Quota' 
     393    Cards: 
     394      base:           'ou=cards,ou=identity,ou=Bifrost,dc=mrvgs,dc=no' 
     395      entry_class:    'Followme::LDAP::Entry::Card' 
     396    PinCodes: 
     397      base:           'ou=pincodes,ou=identity,ou=Bifrost,dc=mrvgs,dc=no' 
     398      entry_class:    'Followme::LDAP::Entry::PinCode' 
     399    Cardreaders: 
     400      base:           'ou=cardreaders,ou=Bifrost,dc=mrvgs,dc=no' 
     401      entry_class:    'Followme::LDAP::Entry::Cardreader' 
     402\end{verbatim} 
     403 
     404 
     405\subsection{Print quotas} 
     406Configuration of print quotas. 
     407Please note that these configuration parameters are only used for the initial creation of user quotas. Afterwards, these values are stored in the user's object in LDAP. 
     408As a consequence, changes to the configuration will only affect new users. 
    408409 
    409410\subsubsection{initialQuota} 
    410 Spesifiserer hvor mye kvote en bruker fÃ¥r i starten, nÃ¥r brukeren fÃ¥r utdelt et kort eller ved oppstart av semesteret
     411Specifies the initial size of a user quota, when the user is given a card, or at the beginning of term
    411412 
    412413\subsubsection{incrementalQuota} 
    413414 
    414 OBS: Ikke lenger i bruk 
     415Note: No longer in use 
    415416 
    416417\subsubsection{incrementSchedule} 
    417418 
    418 OBS: Ikke lenger i bruk 
     419Note: No longer in use 
    419420 
    420421\begin{verbatim} 
    421422Model::Quota: 
    422   initialQuota:       "500" 
    423 \end{verbatim} 
    424  
    425  
    426 \subsection{Pinkoder} 
    427 Konfigurasjon av pinkoder. 
     423  initialQuota:       "500" 
     424\end{verbatim} 
     425 
     426\subsection{Pin codes} 
     427Pin code configuration. 
    428428 
    429429\subsubsection{code\_length} 
    430 Lengden av pinkoder som er tillatt
    431  
    432 Denne mÃ¥ settes til samme lengde som identitetstilbyderne (pinkodeleserne) er konfigurert til
     430Length of pin codes
     431 
     432This must be set to the same length as the identity providers (pin code readers) are configured for
    433433 
    434434\begin{quotation} 
    435 OBS: 
    436 Ikke endre lengden pÃ¥ pinkoder etter systemet er satt i produksjon. 
    437 Det vil fÞre til at brukere ikke lenger fÃ¥r autentisert seg. 
     435Note: 
     436Do not modify pin code lengths after the system is in production. If you do, user will no longer be able to authenticate themselves. 
    438437\end{quotation} 
    439438 
    440439\begin{verbatim} 
    441440Model::PinCodes: 
    442   code_length:        6 
    443 \end{verbatim} 
    444  
    445  
    446 \subsection{Kort} 
    447 Konfigurasjon av kortmodellen. 
     441  code_length:        6 
     442\end{verbatim} 
     443 
     444\subsection{Card} 
     445Configuration of the card model. 
    448446 
    449447\subsubsection{auto\_sn\_prefix} 
    450 Spesifiserer en streng (eller et tegn) som autogenererte ID-er for kort prefikses med
     448Specifies a string (or a character) to be used as prefix for auto-generated IDs
    451449 
    452450\begin{verbatim} 
    453451Model::Cards: 
    454   auto_sn_prefix:    'c' 
    455 \end{verbatim} 
    456  
    457  
    458 \subsection{Kortstatus} 
    459 Konfigurasjon for status pÃ¥ kort
     452  auto_sn_prefix:     'c' 
     453\end{verbatim} 
     454 
     455 
     456\subsection{Card status} 
     457Configuration of card status
    460458 
    461459\subsubsection{entity\_class} 
    462 Spesifiserer hvilken klasse som skal brukes som entitetsklasse for status-objektene
     460Specifies the class to be used as entity class for status objects
    463461 
    464462\subsubsection{default} 
    465 Spesifiserer hvilken status i listen over \textbf{available} som skal vÊre standard
    466 Denne blir ogsÃ¥ den eneste statusen som anses som aktiv, mens alle andre vil deaktivere kortet slik at det ikke kan brukes for utskrift
     463Specifies the default status in the list of \textbf{available} statuses
     464This will be the only active status. All other statuses will disable the card as a means of printing
    467465 
    468466\subsubsection{available} 
    469 En nÞkkel/verdi-liste over status som kan settes pÃ¥ et kort. 
    470 NÞkkelen er et kort navn som bÞr inneholde bare tegn innenfor a-z. 
    471 Verdien er en menneskevennlig tekst. 
    472  
    473 Standard vil bare \textbf{active} vÊre tilgjengelig. 
     467A list of status keys/values that can be assigned to a card. The key is a short name that should only contain alphabetic characters (a-z). The value is a user-friendly text. 
     468 
     469By default, only \textbf{active} will be available. 
    474470 
    475471\begin{verbatim} 
    476472Model::Cards::Status: 
    477  entity_class: 'Followme::Domain::Entity::Status' 
    478   default:      active 
    479  available: 
    480     lost:        Lost 
    481     active:      Active 
    482     locked:      Locked 
    483 \end{verbatim} 
    484  
    485  
    486 \subsection{Kortlesere
    487 Konfigurasjon for kortlesere
     473  entity_class: 'Followme::Domain::Entity::Status' 
     474  default:      active 
     475  available: 
     476    lost:         Lost 
     477    active:       Active 
     478    locked:       Locked 
     479\end{verbatim} 
     480 
     481 
     482\subsection{Card readers
     483Card reader configuration
    488484 
    489485\subsubsection{ldap\_order\_by} 
    490 Kortlesere sorteres etter dette feltet nÃ¥r de listes ut
     486The list of card readers is sorted by this field
    491487 
    492488\subsubsection{ldap\_rdn\_field} 
    493 Feltet i kortleserobjekter som brukes i DN\footnote{Distinguished Name; unik adresse til et objekt i LDAP} for kortlesere
     489The card reader object field that is used in DN\footnote{Distinguished Name; unique address for an LDAP object} for card readers
    494490 
    495491\subsubsection{ldap\_model} 
    496 Navnet pÃ¥ modellen som skal brukes for tilkobling til LDAP. 
    497 Dette navnet pÃ¥ vÊre konfigurert som modell under \textbf{Model::LDAP} (se seksjon \ref{configuration-ldap-models}). 
     492The name of the model used for connecting to LDAP. 
     493This name should be configured as a model under \textbf{Model::LDAP} (see section \ref{configuration-ldap-models}). 
    498494 
    499495\subsubsection{ldap\_filters - find\_all} 
    500 LDAP-filter som brukes ved Ã¥ liste ut alle kortlesere
     496LDAP filter used for listing all all card readers
    501497 
    502498\subsubsection{ldap\_filters - find\_by\_field} 
    503 LDAP-filter som brukes ved Ã¥ hente ut én kortleser. 
     499LDAP filter used for extracting one card reader. 
    504500 
    505501\subsubsection{ldap\_filters - find\_by\_field} 
    506 LDAP-filter som brukes ved sÞk etter kortlesere basert pÃ¥ et attributt
     502LDAP filter used for attribute-based searches for card readers
    507503 
    508504\begin{verbatim} 
    509505Model::Cardreaders: 
    510   ldap_order_by:  macAddress 
    511  ldap_rdn_field: macAddress 
    512   ldap_model:    Cardreaders 
    513  ldap_filters: 
    514     find_all:          '(objectClass=fmCardReader)' 
    515     find_by_field:      '( &(objectClass=fmCardReader)(%s=%s) )' 
    516     search_by_field:    '( &(objectClass=fmCardReader)(%s=*%s*) )' 
    517 \end{verbatim} 
    518  
    519  
    520 \subsection{Brukere
    521 Konfigurasjon for brukere av systemet
     506  ldap_order_by:  macAddress 
     507  ldap_rdn_field: macAddress 
     508  ldap_model:     Cardreaders 
     509  ldap_filters: 
     510    find_all:           '(objectClass=fmCardReader)' 
     511    find_by_field:      '( &(objectClass=fmCardReader)(%s=%s) )' 
     512    search_by_field:    '( &(objectClass=fmCardReader)(%s=*%s*) )' 
     513\end{verbatim} 
     514 
     515 
     516\subsection{Users
     517Configuration of system users
    522518 
    523519\subsubsection{ldap - filter\_all} 
    524 LDAP-filter for Ã¥ hente alle brukere
     520LDAP filter to extract all users
    525521 
    526522\subsubsection{ldap - filter\_find} 
    527 LDAP-filter for Ã¥ sÞke etter brukere
    528 Dette filteret er et stringformat og tar én variabel
     523LDAP filter to search for users
     524This filter is a string format and takes one variable
    529525 
    530526\subsubsection{ldap - filter\_find\_by\_uid} 
    531 LDAP-filter for Ã¥ hente ut én bruker basert pÃ¥ brukernavnet
     527LDAP filter to find one user based on user name
    532528 
    533529\subsubsection{ldap - scope\_find\_by\_uid} 
    534 Skopet som brukes ved sÞk etter en bruker basert pÃ¥ brukernavnet
    535  
    536 Kan vÊre enten
     530The scope used when searching for a user based on user name
     531 
     532Can be one of the following
    537533\begin{itemize} 
    538  \item one 
    539  \item base 
    540  \item sub 
     534 \item one 
     535 \item base 
     536 \item sub 
    541537\end{itemize} 
    542538 
    543539\subsubsection{ldap - username\_field} 
    544 Navnet pÃ¥ LDAP-attributtet som inneholder brukernavn til brukerne
     540Name of the LDAP attribute containing the users' user names
    545541 
    546542\begin{verbatim} 
    547543Model::Users: 
    548  ldap: 
    549     filter_all:        '(objectClass=person)' 
    550     filter_find:        '( &(objectClass=person) ( |(uid=*%1$s*)(cn=*%1$s*) ) )' 
    551     filter_find_by_uid: '( &(objectClass=person)(uid=%s) )' 
    552     scope_find_by_uid:  'one' 
    553     username_field:    'uid' 
    554 \end{verbatim} 
    555  
    556  
    557 \subsection{Tidssone} 
    558 Konfigurasjon for tidssone for serveren og brukerne
     544  ldap: 
     545    filter_all:         '(objectClass=person)' 
     546    filter_find:        '( &(objectClass=person) ( |(uid=*%1$s*)(cn=*%1$s*) ) )' 
     547    filter_find_by_uid: '( &(objectClass=person)(uid=%s) )' 
     548    scope_find_by_uid:  'one' 
     549    username_field:     'uid' 
     550\end{verbatim} 
     551 
     552 
     553\subsection{Time zone} 
     554Configuration of time zone for server and users
    559555 
    560556\begin{verbatim} 
    561557Model::TimeZone: 
    562   name:  'Europe/Oslo' 
    563 \end{verbatim} 
    564  
    565  
    566 \subsection{Dato- og tidsformat} 
    567 Konfigurasjon for dato- og tidsformat. 
    568 Denne konfigurasjonen brukes nÃ¥r kort leses inn for administrasjon
    569 For Ã¥ endre andre konfigurasjoner enn formatet pÃ¥ dato og tid, som for eksempel lokalisering og tidssone, se Perl-modulen \textbf{DateTime::Format::Strptime}\footnote{http://search.cpan.org/perldoc?DateTime::Format::Strptime}
    570 Alle parametere som metoden ``new'' tar imot kan konfigureres her
     558  name:   'Europe/Oslo' 
     559\end{verbatim} 
     560 
     561 
     562\subsection{Date and time format} 
     563Configuration of date and time format. 
     564This configuration is used for reading administrator cards
     565To modify other configurations than date and time format, e.g. localization and time zone, see the \textbf{DateTime::Format::Strptime}\footnote{http://search.cpan.org/perldoc?DateTime::Format::Strptime} Perl module
     566All parameters related to the ``new'' method are configured here
    571567 
    572568\begin{verbatim} 
    573569Model::Timestamp::Format: 
    574   pattern:    '%T %d.%m.%Y' 
    575 \end{verbatim} 
    576  
    577  
    578 \subsection{UtskriftskÞ
    579 Konfigurasjon for behandling av utskriftskÞ i bruker-webgrensesnitt
     570  pattern:    '%T %d.%m.%Y' 
     571\end{verbatim} 
     572 
     573 
     574\subsection{Print queue
     575Configuration of print queue management in the users' web interface
    580576 
    581577\subsubsection{queue} 
    582 Navnet pÃ¥ utskriftskÞen som skal brukes for Ã¥ lete fram brukerens jobber
    583 Dette mÃ¥ vÊre samme navnet som pÃ¥ utskriftsklassen i CUPS som brukes for Ã¥ holde jobber
     578Name of the print queue to be used for identifying the user's print jobs
     579This must be identical to the CUPS print class used to hold/cache?? jobs
    584580 
    585581\subsubsection{lp\_move} 
    586 Full sti til programmet ``lpmove'', som brukes for Ã¥ flytte jobber mellom utskriftskÞer
     582Complete path to the ``lpmove'' application, used for moving jobs between print queues
    587583 
    588584\subsubsection{datetime\_format} 
    589 Formatet pÃ¥ dato og tid som vises i bruker-webgrensesnittet for nÃ¥r jobbene ble sendt til utskrift
     585The date and time format displayed in the users' web interface for when print jobs are submitted
    590586 
    591587\begin{verbatim} 
    592588Model::Jobs: 
    593   queue:            'followme-queue' 
    594   lp_move:          '/usr/sbin/lpmove' 
    595   datetime_format:  '%H:%M %d.%m.%Y' 
    596 \end{verbatim} 
    597  
    598  
    599 \subsection{Epost - sending} 
    600 Konfigurasjon for utsending av epost
    601 Her spesifiseres tegnsett og format pÃ¥ e-postene og adresse eller program for utsending
     589  queue:             'followme-queue' 
     590  lp_move:           '/usr/sbin/lpmove' 
     591  datetime_format:   '%H:%M %d.%m.%Y' 
     592\end{verbatim} 
     593 
     594 
     595\subsection{E-mail - sending} 
     596Configuration of e-mail submission
     597This is where you specify character set and format for e-mail messages and address or application for submission
    602598 
    603599\subsubsection{sender - mailer} 
    604 Denne kan settes til \textbf{SMTP} eller \textbf{Sendmail}. 
    605 Ved Ã¥ spesifisere Sendmail her, vil programmet \textbf{sendmail} benyttes
     600This can be set to \textbf{SMTP} or \textbf{Sendmail}. 
     601If you specify Sendmail, the \textbf{sendmail} application will be used
    606602 
    607603\subsubsection{sender - mailer\_args} 
    608 Dersom SMTP benyttes mÃ¥ \textbf{Host} vÊre satt til adressen til SMTP-tjeneren
    609 Det er ogsÃ¥ mulig Ã¥ sette brukernavn og passord for innlogging pÃ¥ SMTP-tjeneren med \textbf{username} and \textbf{password}. 
     604If using SMTP, you need to set \textbf{Host} to the SMTP server address
     605It is also possible to set user name and password for log-in to the SMTP server with \textbf{username} and \textbf{password}. 
    610606 
    611607\begin{verbatim} 
    612608View::Email: 
    613609  default: 
    614     content_type:  text/plain 
    615     charset:        utf-8 
    616  sender: 
    617     mailer:        'smtp' 
    618     mailer_args: 
    619       host:          'mx.linpro.no' 
    620 \end{verbatim} 
    621  
    622  
    623 \subsection{Autoavbryt
     610    content_type:   text/plain 
     611    charset:        utf-8 
     612  sender: 
     613    mailer:         'smtp' 
     614    mailer_args: 
     615      host:           'mx.linpro.no' 
     616\end{verbatim} 
     617 
     618 
     619\subsection{Auto cancel
    624620\label{configuration-autocancel} 
    625 Konfigurasjon for autoavbryt av gamle utskriftsjobber
     621Configuration of automatic cancelling of old print jobs
    626622 
    627623\subsubsection{expire\_time} 
    628 Settes til antall timer en jobb kan vente pÃ¥ Ã¥ bli skrevet ut. 
    629 Standard er 7 timer. 
     624Set to the maximum number of hours a job can wait before being printed. The default is 7 hours. 
    630625 
    631626\begin{verbatim} 
    632627Controller::Backend::Autocancel: 
    633   expire_time:    7 
    634 \end{verbatim} 
    635  
     628  expire_time:    7 
     629\end{verbatim} 
  • trunk/doc/systemdoc/en/introduction.tex

    r904 r998  
    1 \chapter{Innledning
     1\chapter{About Bifrost
    22 
    3 ``Bifrost'' er navnet pÃ¥ utskriftssystemet utviklet av Redpill Linpro AS. 
     3``Bifrost'' is the name of the printing solution developed by Redpill Linpro AS. 
    44 
     5\section{Introduction} 
    56 
    6 \section{Introduksjon} 
     7Before Bifrost, you had to register every printer in every school with the appropriate driver for each printer. 
     8With Bifrost, adding one printer on your PC enables you to perform the printing on all printers you have physical access to. \footnote{The printers must be connected to the Bifrost system}. 
     9You can use Linux, Windows and MAC OS X for printing with Bifrost. 
    710 
    8 Tidligere har man mÃ¥tte legge til alle skriverne med riktig driver for hver skriver pÃ¥ alle PC-ene. 
    9 Med Bifrost trenger du bare Ã¥ legge til én skriver pÃ¥ PC-en din, og dette gjÞr det mulig Ã¥ skrive ut pÃ¥ hvilken som helst skriver du fysisk har tilgang til\footnote{Forbeholdt at skriveren er tilknyttet Bifrost-systemet}. 
    10 Du kan benytte Linux, Windows eller MAC OS X for Ã¥ skrive ut med Bifrost. 
     11When you send a document to this printer, the print job is submitted to a print queue. Using the magnetic card you have received, you can have your document printed by swiping the card in the card reader connected to the printer you want to use.  
     12The document is printed on the printer. (If you have not received a card, contact your system administrator). 
    1113 
    12 NÃ¥r du skriver ut et dokument til denne skriveren blir utskriftsjobben lagt i en kÞ. 
    13 Du som bruker skal ha fÃ¥tt tildelt et kort med magnetstripe (hvis ikke, ta kontakt med systemansvarlig). 
    14 NÃ¥r du vil hente utskriften din, gÃ¥r du til nÊrmeste skriver og drar kortet i den tilknyttede kortleseren. 
    15 Utskriften blir deretter umiddelbart skrevet ut pÃ¥ skriveren. 
     14The solution architecture allows you to print your print job on any of the printers connected to the Bifrost server, including printers in other buildings or other schools. 
    1615 
    17 Det stÃ¥r en kortleser koblet til alle skriverne, og nÃ¥r du drar kortet ditt vil alle utskrifter du har sendt til ``followme''-kÞen bli skrevet ut pÃ¥ den skriveren som er koblet til kortleseren du dro kortet i. 
     16It is also possible to install Bifrost with numeric keypads (numpad) instead of card readers. 
     17On numpads, users identify themselves with a pin code instead of a magnetic card. 
    1818 
    19 Det er ogsÃ¥ mulig Ã¥ installere Bifrost med numpad istedenfor kortlesere. 
    20 Brukerne benytter dermed seg av en pinkode for Ã¥ identifisere seg, istedenfor et magnetkort. 
     19The solution architecture allows you to pick up your printout on any printer connected to the Bifrost server. The printer may be located in a different room, in a different building, or even a different country. 
    2120 
    22 Grunnet arkitekturen av lÞsningen vil det vÊre mulig Ã¥ hente utskriften din pÃ¥ en hvilken som helst skriver tilknyttet Bifrost-tjeneren. 
    23 Det kan vÊre i et annet rom eller en annen bygning, eller det kan faktisk vÊre et annet land. 
     21\section{License} 
    2422 
    25  
    26 \section{Lisens} 
    27  
    28 Bifrost er utgitt under betingelsene til GNU GPL versjon 2\footnote{GNU GPL versjon 2 finnes pÃ¥ http://www.gnu.org/licenses/gpl-2.0.html}. 
    29 Du finner en kopi av lisensen i fila ``LICENSE'' pÃ¥ rota av prosjektetkatalogen. 
     23Bifrost is licensed in accordance with GNU GPL version 2\footnote{Read more about GNU GPL version 2 on http://www.gnu.org/licenses/gpl-2.0.html}. 
     24A copy of the license is found in the ``LICENSE'' file on the project catalog root. 
  • trunk/doc/systemdoc/en/solution.tex

    r904 r998  
    1 \chapter{LÞsningsbeskrivelse
     1\chapter{Solution description
    22 
    3 \section{Overordnet arkitektur
     3\section{Architecture overview
    44 
    5 LÞsningen bestÃ¥r av én utskriftstjener, som ogsÃ¥ administrerer kvoter, pinkoder, kort og kortlesere. 
    6 Denne kaller vi for ``Bifrost''-tjeneren, eller ``Bifrost-backend''. 
    7 Alle skrivere er lagt inn pÃ¥ denne utskriftstjeneren. 
    8 I tillegg har denne tjeneren to virtuelle utskriftskÞer. 
    9 Den ene heter ``followme'', som alle brukere mÃ¥ legge til, og den andre heter ``followme-queue'' som er kÞen hvor jobbene holdes helt til de sendes til utskrift eller blir kansellert. 
    10 NÃ¥r man skriver ut til ``followme'' vil jobbene bli skrevet ut pÃ¥ nytt til ``followme-queue'', for Ã¥ forhindre at klienten kÞer opp jobbene lokalt nÃ¥r de printer med IPP. 
    11 Alle fysiske skrivere er skjult for vanlige brukere, sÃ¥ all utskrift mÃ¥ gÃ¥ igjennom followme-kÞen. 
     5The solution consists of one print server that also controls quotas, cards and card reader, called the ``Bifrost'' server, or  ``Bifrost-backend'. 
     6All printers are registered on this print server. 
     7This server also has two virtual queues. 
     8One queue is called ``followme'', and must be added by all users. The other, ``followme-queue'', is the queue where jobs reside until they are printed or cancelled. 
     9When submitted to ``followme'', jobs will be also be submitted to ``followme-queue'', in order to avoid jobs piling up locally on the client when using IPP. 
     10All physical printers are hidden from ordinary users, so all printouts must be submitted via the followme queue. 
    1211 
    13 Alle skrivere har tilkoblet en identitetsenhet som er en liten embedded datamaskin, med en USB-kortleser som sender kortdata inn til Bifrost-tjeneren, eller et USB-nummertastatur som sender inn brukerens pinkode. 
     12All printers are connected to an identity unit; a small embedded computer with a USB card reader, which submits card data to the Bifrost server, or a USB numeric keyboard used for entering the user's pin code. 
    1413 
    15 Bifrost-tjeneren finner ut hvilken identitetsenhet som sendte inn brukeridentifiseringen og hvilken skriver denne er koblet til
    16 Videre leter tjeneren opp kortet eller pinkoden i LDAP-databasen og finner fram brukeren som eier enten kortet eller pinkoden som ble brukt
     14The Bifrost server identifies the indentity unit that submitted the card data and which printer it is connected to
     15The server also locates the card or pin code in the LDAP database, identifying the user associated with the card or pin code
    1716 
    18 Dermed blir alle brukerens utskriftsjobber sendt til skriveren
     17Next, all print jobs submitted by that user are sent to the printer
    1918 
    2019 
    21 \section{LÞsningsskisse
     20\section{Solution model
    2221 
    23 Figur \ref{fig:solution-model} viser komponenter og forbindelser/dataflyt i systemet. 
    24 Figuren viser klientmaskiner som bÃ¥de maskiner for administrasjon og studenter som benytter seg av lÞsningen. 
    25 De kommuniserer mot CUPS i backend for Ã¥ skrive ut dokumenter, enten direkte over IPP eller via Samba. 
    26 Skriverne er skjult bak CUPS-systemet i backend
    27 CUPS holder telling pÃ¥ brukernes utskriftskvoter ved Ã¥ telle antall sider i PostScript-dokumentet. 
     22Figure \ref{fig:solution-model} displays the system components and connections/dataflow.  
     23The figure shows client computers, both administration computers and student computers using the solution. 
     24They communicate with backend CUPS to print documents, either directly using IPP or via Samba. 
     25The printers are hidden behind the backend CUPS system
     26CUPS keeps track of user print quotas by counting the number of pages in the PostScript document. 
    2827 
    29 Via et webgrensesnitt fra Apache kan brukere administrere egne jobber og fÃ¥ oversikt over sin utskriftskvote
    30 Administratorer kan merke kort som mistet/funnet, administrere pinkoder, administrere kvotepÃ¥fyll og administrere kortlesere
     28Using an Apache web interface, users can control their own jobs and view their print quota status
     29Administrators can tag cards as lost/found, and manage pin codes, quota refills and card readers
    3130 
    32 Autoavbryt sÞrger for automatisk fjerning av gamle utskriftsjobber fra kÞen
     31Autocancel automatically deletes old print jobs from the queue
    3332 
    34 Kortleseren er tilkoblet en OpenWRT-boks som sender en melding til Bifrost-backend nÃ¥r et kort dras igjennom leseren. 
    35 Tilsvarende vil vil en OpenWRT-boks med tilkoblet nummertastatur (numpad) sende en melding til Bifrost-backend nÃ¥r pinkoden tastes inn. 
    36 Bifrost-backend finner ut hvilken identitetsenhet som ble benyttet og vil sÃ¥ flytte alle utskriftsjobber for denne brukeren fra followme-kÞen over til den aktuelle skriveren. 
    37 OpenWRT-boksene kan overvÃ¥kes med SNMP, fra for eksempel HP OpenView. 
     33The card reader is connected to an OpenWRT box which submits to the a message to the Bifrost back-end when a card is swiped through the reader. Likewise, an OpenWRT box with a numeric keypad (numpad) attached will submit a message to the Bifrost back-end when the pin code is entered. 
     34The Bifrost back-end identifies which identity unit was used, and moves all the user's print jobs from the followme queue to the printer. The OpenWRT boxes can be monitered using SNMP, from e.g. HP OpenView. 
    3835 
    39 LDAP-skjema for brukernes kort og utskriftskvoter lagres i LDAP pÃ¥ Bifrost Backend. 
    40 Brukerdata kan hentes fra en allerede eksisterende LDAP-tjener. 
    41 Active Directory er stÞttet som datalager for brukere. 
     36LDAP forms containing user cards and quotas are stored in LDAP on Bifrost Back-end. User data cna be retrieved from an existing LDAP server. Active Directory is supported as data storage for users. 
    4237 
    4338\begin{quotation} 
    44 OBS: 
    45 Det er ikke stÞtte for replikering av LDAP, fordi backend-applikasjonen ikke stÞtter skriving til én tjener og lese fra en annen. 
    46 I tillegg kan latens i nettverket og replikering fÞre til at oppdateringer og nye LDAP-objekter ikke umiddelbart blir tilgjengelig i webgrensesnittet. 
     39 
     40NOTE: 
     41LDAP replication is not supported , since the back-end application does not support printing to one server and reading from another. 
     42Furthermore, network latency and replication may keep updates and new LDAP objects from becoming available immediately in the web interface. 
     43 
    4744\end{quotation} 
    4845 
    4946 
    5047\begin{figure} 
    51  \centering 
    52  \includegraphics[bb=0 0 340 475]{solution-model.png} 
    53  % solution-model.png: 680x940 pixel, 90dpi, 19.19x26.53 cm, bb=0 0 544 752 
    54  \caption{LÞsningsskisse
    55  \label{fig:solution-model} 
     48 \centering 
     49 \includegraphics[bb=0 0 340 475]{solution-model.png} 
     50 % solution-model.png: 680x940 pixel, 90dpi, 19.19x26.53 cm, bb=0 0 544 752 
     51 \caption{Solution model
     52 \label{fig:solution-model} 
    5653\end{figure} 
  • trunk/doc/systemdoc/en/systemdocumentation.tex

    r904 r998  
    88 
    99% Title Page 
    10 \title{Bifrost 1.1 Systemdokumentasjon} 
     10\title{Bifrost 1.1 System documentation} 
    1111\author{Redpill Linpro AS} 
    1212 
     
    1515 
    1616\begin{abstract} 
    17 Bifrost er et utskriftssystem utviklet av Linpro AS for MÞre og Romsdal Fylkeskommune og er utgitt under betingelsene til GNU GPL versjon 2. 
    18 LÞsningen benytter magnetkort, kortlesere og utskriftskvoter
    19 Alternativt for magnetkort og kortlesere kan numpad og pinkoder benyttes istedet
    20 Brukere forholder seg til én skriver pÃ¥ datamaskinen sin og kan hente utskriften sin pÃ¥ hvilken som helst skriver tilknyttet lÞsningen
    21 LÞsningen fungerer med Linux, Windows og MAC OS X og benytter seg av Postscript. 
     17Bifrost is a printing solution developed by Linpro AS for the MÞre and Romsdal county council in Norway, licensed in accordance with GNU GPL version 2. 
     18The solution is based on magnetic cards, card readers and print quotas
     19Numeric keypads and pin codes can be used instead of magnetic cards and card readers
     20Users send their print jobs to one generic printer, and can print the document on any printer connected to the system
     21The solution supports Linux, Windows and MAC OS X, and uses Postscript. 
    2222\end{abstract} 
    2323 
  • trunk/doc/systemdoc/en/technical.tex

    r919 r998  
    1  
    2 \chapter{Teknisk beskrivelse} 
    3  
    4 Dette kapittelet beskriver den tekniske lÞsningen. 
    5  
    6  
    7 \section{Identitetsenhet} 
    8  
    9 Det benyttes trÃ¥dlÞse rutere av typen \textbf{ASUS WL-500G Premium} med en modifisert versjon av OpenWRT\footnote{OpenWRT er en Linux-distribusjon for embedded-systemer. http://openwrt.org/} som identitetsenheter. 
    10 Disse boksene har USB-grensesnitt hvor det enten kobles til en USB-kortleser av typen MAGTEK med tastaturgrensesnitt eller et numerisk tastatur med USB-grensesnitt. 
    11  
    12 FÞlgende rutere er testet og fungerer med Bifrost: 
    13 \begin{itemize} 
    14  \item ASUS WL-500G Premium (ute av produksjon) 
    15  \item ASUS WL-500W 
    16 \end{itemize} 
    17  
    18  
    19 \subsection{USB-kortlesere} 
    20 USB-kortleserne mÃ¥ programmeres om til Ã¥ sende kortdataene som \textbf{ALT-ASCII}. 
    21 Disse leser alle tre sporene fra kort som leses inn. 
    22  
    23 \subsection{Numerisk tastatur} 
    24 Et numerisk tastatur kan kobles til. 
    25 Ruteren mÃ¥ benytte et firmware med stÞtte for ``numpad''. 
    26  
    27 \subsection{Nettverksbro} 
    28 ASUS-boksene er programmert til Ã¥ bridge trafikken mellom WAN-porten og fÞrste LAN-port i ruteren. 
    29 Dette gjÞr det mulig Ã¥ koble til skriveren pÃ¥ denne porten slik at skriveren fÃ¥r sin egen IP-adresse fra DHCP. 
    30 Dette halverer antall nettverkspunkter som mÃ¥ legges opp ut til hver skriver. 
    31  
    32 \subsection{SSH-innlogging} 
    33 Ved utrulling av kortlesere \textbf{mÃ¥} det legges inn en offentlig SSH-nÞkkel for Ã¥ tillate administrasjon av kortleserne. 
    34 Innlogging med passord er stengt. 
    35  
    36 \subsection{WEB-grensesnitt} 
    37 Web-grensesnitt er ikke aktivert. 
     1\chapter{Technical description} 
     2 
     3This chapter describes the technical solution. 
     4 
     5 
     6\section{Card readers} 
     7Bifrost uses \textbf{ASUS WL-500G Premium} wireless routers with a modified version of OpenWRT\footnote{OpenWRT is a Linux distribution for embedded systems. http://openwrt.org/} card readers. 
     8These units have a USB interface that can either be connected to a MAGTEK USB card reader with keyboard interface or a numeric keypad with a USB interface. 
     9 
     10These routers have been tested and confirmed to work with Bifrost: 
     11\begin{itemize} 
     12 \item ASUS WL-500G Premium (out of production) 
     13 \item ASUS WL-500W 
     14\end{itemize} 
     15 
     16\subsection{USB card readers} 
     17USB card readers must be reprogrammed in order to submit card data as \textbf{ALT-ASCII}. 
     18The card readers read all the three tracks on cards that are swiped. 
     19 
     20\subsection{Numeric keypad} 
     21You can connect a numeric keypad to the solution. 
     22The router must use firmware with ``numpad'' support. 
     23 
     24\subsection{Network bridge} 
     25The ASUS boxes are programmed to bridge the traffic between the WAN port and the router's first LAN port. 
     26This enables you to connect to the printer on this port in order to assign a specific IP address from DHCP to the printer. 
     27This reduces the number of network points for each printer by half. 
     28 
     29\subsection{SSH login} 
     30Wen rolling out the card readers, it is \textbf{required} to add an official SSH key to allow card reader management. 
     31Password login is blocked. 
     32 
     33\subsection{Web interface} 
     34Web interface is not activated. 
    3835 
    3936\subsection{SNMP} 
    40 SNMP er aktivert. ``Community''-frasen kan settes ved generering av firmware'n til kortleserne. 
    41  
    42 \subsection{Innhenting av identifikasjon} 
    43 En bakgrunnsprosess leser inn data fra kort eller pinkoder fra numpad og sender dette til Bifrost Backend. 
    44 Denne prosessen mÃ¥ kjÞre pÃ¥ ruterne til enhver tid. 
    45  
    46  
    47 \section{Bifrost Backend} 
    48  
    49 Bifrost Backend er en del av Bifrost-tjeneren som hÃ¥ndterer forespÞrsler fra kortleserne og autoavbryt av gamle utskriftsjobber. 
    50  
    51 \subsection{Innleste kort} 
    52 Kortlesere sender innleste kort som tre parametere, én for hvery spor pÃ¥ kortet. 
    53 Dersom kortleseren er tilknyttet en skriver vil brukeren av kortet letes opp og alle dens jobber blir sendt til skriveren. 
    54 Dersom kortleseren er en administrasjonskortleser\footnote{Alle kortlesere som ikke er tilknyttet en skriver er administrasjonskortlesere} vil kortdataene bli mellomlagret for administrasjon i web-grensesnittet. 
    55  
    56 \subsection{Innleste pinkoder} 
    57 Numpad sender inn pinkoden som tastes inn (en predefinert lenge pÃ¥ pinkoder, normalt 6 sifre). 
    58 Dersom identitietsenheten er tilknyttet en skriver vil brukeren av pinkoden letes opp og alle dens jobber blir sendt til skriveren. 
    59  
    60 \subsection{Identifisere identitetsenheten} 
    61 Identitetsenheter identifiseres pÃ¥ MAC-adresse. 
    62 De tildeles en dynamisk IP-adresse fra DHCP. 
    63 NÃ¥r en forespÞrsel kommer inn gjÞres det oppslag i ARP-tabellen pÃ¥ IP-adressen. 
    64 Dette forutsetter at tjeneren og kortleserne er pÃ¥ samme subnett. 
    65  
    66 Dersom det ikke er tilfellet vil det ikke vÊre mulig Ã¥ slÃ¥ opp i ARP-tabellen. 
    67 Ved Ã¥ endre i konfigurasjonen (se seksjon \ref{configuration-mac-lookup}) kan man tillate at kortlesere sender med en parameter ``macaddress'' som brukes istedenfor oppslaget i ARP-tabellen. 
    68 Bemerk at denne funksjonaliteten kun benyttes dersom oppslaget i ARP-tabellen feiler. 
    69 Ã 
    70  aktivere denne funksjonaliteten innebÊrer en sikkerhetsrisiko, fordi hvem som helst vil kunne identifisere seg som en identitetsenhet bare ved Ã¥ vite MAC-adressen til en av dem. 
    71 Backend er ellers beskyttet med en liste over konfigurerte nettverksadresser som er gitt tilgang. 
    72  
    73 \subsection{Utskriftsfeilmeldinger} 
    74 Feil ved utskrift i CUPS\footnote{CUPS er utskriftstjeneren som benyttes. http://www.cups.org} blir rapportert til Bifrost Backend og e-post blir sendt ut til brukeren som eier utskriftsjobben og til systemadministrator. 
    75  
    76 \subsection{Autoavbryt} 
    77 Gamle utskriftsjobber vil automatisk bli kansellert. 
    78 En passende maksimal levetid pÃ¥ utskriftsjobber er 7 timer, som er omtrentlig én hel dag pÃ¥ skolen. 
    79 Denne levetiden kan endres i konfigurasjonsfilen (se seksjon \ref{configuration-autocancel}). 
    80 Dette gjÞres fordi gamle utskriftsjobber mest sannsynlig er glemt, og derfor ikke Þnsket neste gang brukeren skriver ut noe. 
    81 En e-post sendes ut til eier av utskriftsjobben nÃ¥r en jobb kanselleres. 
    82  
    83 \subsection{Brukergrupper} 
    84 Brukeren som kjÞrer Bifrost-tjeneren, som trolig vil vÊre \textbf{www-data} dersom Bifrost kjÞres igjennom Apache og FastCGI, mÃ¥ vÊre i gruppen \textbf{lpadmin} for Ã¥ fÃ¥ tilgang til Ã¥ flytte utskriftsjobber mellom skrivere. 
    85  
    86  
    87 \section{Utskriftskvote} 
    88  
    89 Bifrost stÞtter utskriftskvoter. 
    90  
    91 \subsection{Initiell kvoteverdi} 
    92 Alle brukere for en initiell kvoteverdi nÃ¥r de tilordnes sitt fÞrste kort. 
    93 Denne er normalt 500, men kan overstyres i konfigurasjonen. 
    94  
    95 \subsection{Kalkulert kvote} 
    96 Kostnaden ved Ã¥ skrive ut et dokument er avhengig av tre faktorer. 
    97  
    98 \begin{itemize} 
    99  \item Antall sider 
    100  \item Antall kopier 
    101  \item Kvotevekting pÃ¥ skriveren 
    102 \end{itemize} 
    103  
    104 Alle disse tre verdiene er multiplisert for Ã¥ finne tallet som brukeren trekkes for i kvote. 
    105  
    106 \subsection{Kvotevekting} 
    107 Hver skriver kan ha egen kvotevekt. 
    108 Normalt vil denne vÊre 1, men dersom man benytter seg av dupleksfunksjonen pÃ¥ skriveren vil man kanskje senke denne til 0.5 eller 0.75. 
    109 Ved utskrift pÃ¥ en fargeskriver kan det tenkes at kvotevekten Þkes til 2. 
    110 Dette er kun eksempeler. 
    111  
    112 Vektingen settes som en parameter til CUPS backend-driveren (se seksjon \ref{cups-backends}). 
     37SNMP is activated. You can set the ``Community'' phrase when generating the card reader firmware. 
     38 
     39\subsection{Reading identification data} 
     40A background process reads data from magnetic cards or pin codes, and sends the data to Bifrost Back-end. 
     41This process must be run continuously. 
     42 
     43 
     44\section{Bifrost Back-end} 
     45 
     46Bifrost Back-end is part of the Bifrost server, handling queries from the card readers and auto-cancelling of old print jobs. 
     47 
     48\subsection{Data from swiped cards} 
     49Card readers submits data from swiped cards as three parameters, one for each track on the card.  
     50If the card reader is connected to a printer, the user associated with the card is identified and all the user's print jobs will be submitted to that printer. 
     51If the card reader is an administration card reader\footnote{i e any card reader not connected to a printer}, the card data will be cached for administration in the web interface. 
     52 
     53\subsection{Data from pin codes} 
     54The numeric keypad (Numpad) submits the pin code used (a pre-defined pin code length, usually 6 digits). 
     55If the identity unit is connected to a printer, the system will identify the pin code user and print all the user's print jobs on that printer. 
     56 
     57\subsection{Identifying identity units} 
     58Identity units are identified by MAC address. 
     59They are assigned a dynamic IP address from DHCP. 
     60When a query is received, an inquiry of the IP address is made in ARP table. 
     61This requires that the server and the card readers are located on the same subnet. 
     62 
     63If they are not, it will not be possible to make an inquiry into the ARP table. 
     64By modifying the configuration (see section \ref{configuration-mac-lookup}), card readers are allowed to submit with one  ``macaddress'' parameter instead of the ARP table inquiry. 
     65Please note that this functionality can only be used if the ARP table inquiry fails. 
     66 
     67Activating this functionality implies a security risk, since anyone can identify themselves as an identity unit if they know a unit's MAC address. 
     68Back-end is protected by a list of configured network addresses that have been granted access. 
     69 
     70\subsection{Print messages} 
     71Errors during CUPS\footnote{CUPS is the print server used. http://www.cups.org} printing are reported to the Bifrost Back-end, and an e-mail is submitted to the print job owner/user and to the system administrator. 
     72 
     73\subsection{Autocancel} 
     74Old print jobs will be cancelled automatically. 
     75A suggested maximum lifetime of a print job is 7 hours, i e approximately one school day. 
     76This lifetime can be modified in the configuration file (see section \ref{configuration-autocancel}). 
     77 
     78Autocancel is useful since old print jobs are usually forgotten, and unwanted the next time the user submits something to the printer. 
     79When a print job is cancelled, an e-mail is submitted to print job owner. 
     80 
     81\subsection{User groups} 
     82The user running the Bifrost server, probably \textbf{www-data} if Bifrost is run on Apache and FastCGI, must be a member of the \textbf{lpadmin} group in order to be allowed to move print jobs between queues. 
     83 
     84 
     85\section{Print quota} 
     86 
     87Bifrost supports print quotas. 
     88 
     89\subsection{Initial quota} 
     90All users receive an initial quota with their first card.  
     91The initial quota is usually 500, but this can me modified in the configuration. 
     92 
     93\subsection{Calculated quota} 
     94The cost of printing a document depends on three factors. 
     95 
     96\begin{itemize} 
     97 \item The number of pages 
     98 \item The number of copies 
     99 \item Quota weighting on the printer 
     100\end{itemize} 
     101 
     102These three values are multiplied in order to calculate the quota-related cost of printing for the user. 
     103 
     104\subsection{Quota weighting} 
     105A separate quota weight may be assigned to each printer. 
     106Usually, this will be 1, but when the user selects the duplex option on the printer, it may be reasonable to reduce the weight to 0.5 or 0.75. 
     107For printing in colour, you may want to increase the quota weight to 2. 
     108These are only suggestions. 
     109 
     110The weighting is specified as a parameter to the CUPS back-end driver (see section \ref{cups-backends}). 
    113111 
    114112\begin{quotation} 
    115 OBS: 
    116 Bifrost stÞtter for tiden kun hele kvoter, altsÃ¥ heltall. 
    117 En utskrift kan derfor ikke koste 2.5. 
     113NOTE: 
     114Bifrost only supports integers as quotas. A printout cannot cost e.g. 2.5. 
    118115\end{quotation} 
    119116 
    120117\section{OpenLDAP} 
    121118 
    122 Systemet benytter LDAP for oppslag og lagring av data. 
    123 Systemet er utviklet med fokus mot OpenLDAP. 
    124  
    125 For lagring av Bifrost-data anbefales det sterkt at man bruker OpenLDAP. 
    126 Brukere kan lagres i andre typer LDAP-databaser (f.eks. Active Directory) ved Ã¥ gjÞre noen konfigurasjonsendringer i Bifrost, CUPS og Samba. 
    127  
    128  
    129 \subsection{Skjemaer} 
    130 Det benyttes noen skjermaer som ikke fÞlger med som standard i OpenLDAP, noen av disse er utviklet for dette formÃ¥let. 
    131 Disse skjemaene mÃ¥ kopieres inn i skjemakatalogen (\texttt{/etc/ldap/schema/} for OpenLDAP) og inkluderes i konfigurasjonsfilen til LDAP (\texttt{/etc/ldap/slapd.conf} for OpenLDAP). 
    132  
    133 \begin{itemize} 
    134  \item Brukerinformasjon benytter objektklassen \textbf{posixAccount}, som fÞlger med OpenLDAP 
    135  \item Gruppeinformasjon for brukerne dersom de er organisert i grupper innenfor samme gren benytter objektklassen \textbf{posixGroup}, som fÞlger med OpenLDAP 
    136  \item Brukerinformasjon for autentisering mot Samba benytter objektklassen \textbf{sambaSamAccount}, som fÞlger med Samba 
    137  \item Utskriftskvoter benytter objektklassene \textbf{fmPrinterQuota} og \textbf{fmPrinterQuotaHolder}, begge utviklet for Bifrost. 
    138  \item Kortlesere benytter objektklassen \textbf{fmCardReader}, utviklet for Bifrost. 
    139  \item Kort benytter objektklassen \textbf{magneticCard}, utviklet for Bifrost. 
    140  \item Pinkoder benytter objektklassen \textbf{fmPinCode}, utviklet for Bifrost. 
    141 \end{itemize} 
    142  
    143 Utviklede skjemaer for Bifrost finnes under \texttt{src/LDAP/schema/}. 
    144  
    145 \subsection{Eksempler pÃ¥ oppsett} 
    146 Bifrost er testet med fÞlgende LDAP-oppsett: 
    147 \begin{itemize} 
    148  \item Én OpenLDAP-database for bÃ¥de Bifrost-data og brukerdata. 
    149  \item Én OpenLDAP-database for Bifrost-data og én OpenLDAP-database for brukerdata. 
    150  \item Én OpenLDAP-database for Bifrost-data og én Active Directory-database for brukerdata. 
    151 \end{itemize} 
    152  
    153  
     119The system uses LDAP for inquiries and storing data. 
     120The system is developed with OpenLDAP in mind, but other kinds of LDAP databases can be used without major modifications. 
     121 
     122OpenLDAP is recommended for storing Bifrost data. 
     123User may be stored in other LDAP database types (e.g. Active Directory) by reconfiguring Bifrost, CUPS and Samba. 
     124 
     125\subsection{Schemas} 
     126Bifrost uses some schemas that are not included by default in OpenLDAP, some of these have been specifically designed for Bifrost. 
     127These schemas must be copied into the schema catalog (\texttt{/etc/ldap/schema/} for OpenLDAP) and included in the LDAP (\texttt{/etc/ldap/slapd.conf} configuration file for OpenLDAP). 
     128 
     129\begin{itemize} 
     130 \item User information uses the \textbf{posixAccount} object class, which is included in OpenLDAP 
     131 \item Group information for users if they are organized in groups inside the same branch use the \textbf{posixGroup} object class, which is included in OpenLDAP 
     132 \item User information for Samba authentication uses the \textbf{sambaSamAccount} object class, which is included in Samba 
     133 \item Print quotas use the \textbf{fmPrinterQuota} and \textbf{fmPrinterQuotaHolder} object classes; both have been developed for Bifrost. 
     134 \item Card readers use the \textbf{fmCardReader} object class, which has been developed for Bifrost. 
     135 \item Cards use the \textbf{magneticCard} object class, which has been developed for Bifrost. 
     136 \item Pin codes use the \textbf{fmPinCode} object class, which has been developed for Bifrost. 
     137\end{itemize} 
     138 
     139Schemas developed for Bifrost, and a copy of the Samba schema, are found in \texttt{src/LDAP/schema/}. 
     140 
     141\subsection{Setup examples} 
     142Bifrost has been tested with the following LDAP configurations: 
     143\begin{itemize} 
     144 \item One OpenLDAP database for both Bifrost data and user data. 
     145 \item One OpenLDAP database for Bifrost data and one OpenLDAP database for user data. 
     146 \item One OpenLDAP database for Bifrost data and one Active Directory database for user data. 
     147\end{itemize} 
    154148 
    155149\section{CUPS} 
    156150\label{cups} 
    157151 
    158 CUPS benyttes som utskriftslÞsning i Bifrost
    159 Den autentiserer brukere mot LDAP og benytter spesielle backends for Ã¥ behandle utskriftsjobber for Ã¥ stÞtte utskriftskvoter og kÞing. 
    160  
    161 \subsection{Autentisering
    162 CUPS autentiserer brukere mot LDAP med PAM. 
    163 CUPS krever at brukerne er tilgjengelige i UNIX-miljÞet, sÃ¥ nsswitch.conf mÃ¥ ogsÃ¥ settes opp med LDAP-stÞtte
    164  
    165 \subsection{UtskriftskÞer
    166 Det mÃ¥ opprettes en utskriftskÞ for Ã¥ autentisere brukere og ta i mot utskriftsjobber
    167 Denne kaller vi for ``followme''. 
    168 Denne kÞen sender utskriftene videre til en ny kÞ, en utskriftsklasse som mÃ¥ opprettes og gis navnet ``followme-queue''
    169 Denne klassen brukes for Ã¥ holde igjen utskrifter sendt fra ``followme''-kÞen
    170 Denne klassen skal vÊre tom, altsÃ¥ en klasse uten assosierte skrivere
    171  
    172 Se seksjon om CUPS ``route''-backend (\ref{cups-backends}) om forholdet mellom ``followme''- og ``followme-queue''-kÞene
    173  
    174 Vi mÃ¥ ha minst én skriver og én klasse for at Bifrost skal fungere
    175 I tillegg mÃ¥ alle fysiske skrivere legges til i CUPS, med ``followme''-backend. 
    176  
    177 \subsection{Backends} 
     152Bifrost uses CUPS as a print solution
     153CUPS authenticates users against LDAP, and uses back-ends to manage print jobs to support print quotas and queuing. 
     154 
     155\subsection{Authentication
     156CUPS authenticates uses against LDAP with PAM. 
     157CUPS requires users to be available in the UNIX environment; as a consequence nsswitch.conf must be set up with LDAP support
     158 
     159\subsection{Print queues
     160You need to create a print queue to authenticates users and receive print jobs
     161This queue is called ``followme''. 
     162This queue forwards the print jobs to another queue, a print class you also need to create, to cache print jobs from the ``followme'' queue
     163This class is used for holding print jobs submitted from the ``followme'' queue
     164This class should be empty, in other words a class with no printers associated to it
     165 
     166See the section about CUPS ``route'' backend (\ref{cups-backends}) for more information on the relationship between the ``followme'' and ``followme-queue'' queues
     167 
     168Bifrost requires at least one printer and one class
     169In addition, all physical drivers must be included in CUPS, with ``followme'' back-end. 
     170 
     171\subsection{Back-ends} 
    178172\label{cups-backends} 
    179 Det er utviklet et par CUPS backends for Bifrost. 
    180 Den ene hÃ¥ndterer brukernes kvoter ved utskrift og den andre er for Ã¥ sende utskrifter til vente-kÞen
     173A couple of CUPS back-ends have been developed for Bifrost. 
     174One of them handles user print quotas, the other submits print jobs to the ??vente-kÞen??
    181175 
    182176\subsubsection{followme} 
    183 CUPS backend-driveren ``followme'' mÃ¥ knyttes til \textbf{alle} skrivere som Þnskes brukt i lÞsningen. 
    184 Denne brukes for Ã¥ sjekke og oppdatere brukernes kvoter nÃ¥r dokumentene sendes til en skriver for utskrift
    185  
    186 En skriver kan legges til pÃ¥ samme mÃ¥te i CUPS som tidligere, men man mÃ¥ gÃ¥ inn og endre URI-en til skriveren
    187 Den nye URI-en til skriveren skal vÊre pÃ¥ formatet
     177The ``followme'' CUPS back-end driver must be assigned to \textbf{all} printers that are used by the solution. 
     178This driver is used for checking and updating user print quotas when documents are submitted to a printer for printing
     179 
     180A printer can be added in CUPS in the normal way, but you need to modify the printer's URI
     181The format of the new printer URI
    188182\begin{verbatim} 
    189  followme:/1/<original URI> 
     183 followme:/1/<original URI> 
    190184\end{verbatim} 
    191185 
    192 Denne endringen kan gjÞres manuelt i \texttt{/etc/cups/printers.conf}, som trolig er den enkleste og raskeste mÃ¥ten. 
    193 Husk at followme-utskriftskÞene skal \textbf{IKKE} bruke denne backenden, kun vanlige skrivere. 
    194  
     186This modification may be performed manually in \texttt{/etc/cups/printers.conf}; which is probably the easiest and fastest way. 
     187Keep in mind that the followme print queues should \textbf{NOT} use this back-end, only ordinary printers. 
    195188 
    196189\begin{quotation} 
    197 VIKTIG
    198 PÃ¥ systemer som kjÞrer CUPS som \textbf{root} (som Ubuntu Gutsy) er backend-driverne ``http'', ``ipp'' og ``lpd'' normalt eid av root med rettighetene ``700''
    199 Det betyr at kun root kan eksekvere disse
    200 CUPS vil kjÞre backends som en annen bruker med mindre rettigheter, for eksempel som \textbf{lp}, hvis dette er mulig
    201 Det er derfor viktig at rettighetene pÃ¥ ``followme''-backend settes til ``700'' og eies av root, fordi den mÃ¥ kunne sende utskriftsjobber til andre backends, som for eksempel ``ipp''. 
    202  
    203 Ubuntu Feisty har ikke det samme problemet med rettigheter pÃ¥ filene, og CUPS kjÞres under brukeren \textbf{cupsys}
     190IMPORTANT
     191On systems running CUPS as \textbf{root} (e.g. Ubuntu Gutsy), the back-end drivers ``http'', ``ipp'', and ``lpd'' are normally owned by root with ``700'' rights
     192This means that they can only be executed by root
     193CUPS will run back-ends as an ordinary user with fewer rights, for instance as \textbf{lp}, if possible
     194As a consequence, it is important that the rights on the ``followme'' back-end is set to ``700'' and owned by root, since it must be able to submit print jobs to other back-ends, such as ``ipp''. 
     195 
     196Ubuntu Feisty does not have the same problem with rights, and CUPS is run under the \textbf{cupsys} user
    204197\end{quotation} 
    205198 
    206199 
    207200\subsubsection{route} 
    208 CUPS backend-driveren ``route'' mÃ¥ brukes pÃ¥ utskriftskÞen som brukerne sender sine utskrifter til, som heter ``followme''. 
    209 Denne backend-driveren tar en parameter som er navnet pÃ¥ utskriftskÞen som skal brukes for Ã¥ holde igjen utskrifter. 
    210 Her holdes de helt til de videresendes til en skriver eller blir for gamle og kansellert. 
    211  
    212 URI-en til utskriftskÞen skal settes slik: 
     201The ``route'' CUPS back-end driver must be used on the print queue receiving user print jobs, called ``followme''. 
     202This back-end driver takes a parameter which is the name of the print queue used for caching print jobs until they are submitted to a printer or are cancelled. 
     203 
     204The print queue URI is set as follows: 
    213205\begin{verbatim} 
    214  route:/followme-queue 
     206 route:/followme-queue 
    215207\end{verbatim} 
    216208 
    217 I dette eksempelet blir ``followme-queue''-kÞen brukt for Ã¥ holde igjen utskrifter
     209In this example, the ``followme-queue'' queue is used for caching print jobs
    218210 
    219211\begin{quotation} 
    220 VIKTIG
    221 Pakken cupsys-bsd mÃ¥ vÊre installert for at route-backend skal fungere
    222 Den avhenger av kommandoen ``lpr''
     212IMPORTANT
     213The cupsys-bsd packet must be installed in order for the route-backend to work
     214This depends on the ``lpr'' command
    223215\end{quotation} 
    224216 
    225217 
    226 \subsection{Parallelle followme-kÞer
    227 Dersom man har forskjellige skrivermodeller og Þnsker mulighet for Ã¥ bruke spesielle funksjoner pÃ¥ disse, som for eksempel duplex og stifting, sÃ¥ kan man installere flere followme-kÞer i CUPS og bruke skriverens egen driver, istedenfor en generell PostScript-driver. 
    228  
    229 Anbefaler at navnene pÃ¥ kÞene begynner med ``followme''. 
    230 Her er noen eksempler pÃ¥ kÞer
    231 \begin{itemize} 
    232  \item ``followme'' (standardkÞen
    233  \item ``followme.duplex'' 
    234  \item ``followme.stapler'' 
    235  \item ``followme.hp4350'' 
    236 \end{itemize} 
    237  
    238 Bruk gjerne driver fra CUPS som passer best til printeren, slik at dere kan sette standardinnstillinger pÃ¥ skriveren
    239  
    240 For at IPP-klienter skal kunne bruke de nye kÞene mÃ¥ det legges til tilgangskontroll pÃ¥ disse skriverne i \texttt{/etc/cups/cupsd.conf}. 
    241 Legg til denne blokken for hver nye followme-kÞ du setter opp
    242 Endre verdien i ``Location'' til navnet pÃ¥ den nye skriveren, for eksempel \textbf{followme-duplex}: 
     218\subsection{Parallel followme queues
     219If you have different printer models and wish to use some of their special functions, for instance duplex and stapling, you can install additional followme queues in CUPS and use the printer's own driver instead of a generic PostScript driver. 
     220 
     221We recommend that the names of these queues start with ``followme''. 
     222Examples
     223\begin{itemize} 
     224 \item ``followme'' (default queue
     225 \item ``followme.duplex'' 
     226 \item ``followme.stapler'' 
     227 \item ``followme.hp4350'' 
     228\end{itemize} 
     229 
     230We suggest that you use the CUPS driver that is most suitable for the printer, so that you can define the printer defaults yourself
     231 
     232In order for IPP clients to be able to use the  new queues, you need to assign access rights to these printers in \texttt{/etc/cups/cupsd.conf}. 
     233Add this section for every new followme queue you define
     234Change the ``Location'' value to the name of the new printer, for instance \textbf{followme-duplex}: 
    243235\begin{verbatim} 
    244236<Location /printers/followme-duplex> 
    245  AuthType Default 
    246  Require valid-user 
    247  Order allow,deny 
    248  Allow all 
     237  AuthType Default 
     238  Require valid-user 
     239  Order allow,deny 
     240  Allow all 
    249241</Location> 
    250242\end{verbatim} 
    251243 
    252  
    253 Husk ogsÃ¥ Ã¥ legge disse utskriftskÞene til i \texttt{/etc/samba/printcap} (se \ref{samba-printcap}). 
    254  
     244Don't forget to add these print queues to \texttt{/etc/samba/printcap} (see \ref{samba-printcap}). 
    255245 
    256246\section{Samba} 
    257247 
    258 Som et alternativ til IPP, som benyttes av CUPS, kan man benytte Samba til utskrift
     248You can also use Samba for printing, as an alternative to IPP, which is used by CUPS
    259249 
    260250\subsection{printcap} 
    261 \label{samba-printcap} 
    262 Det bÞr benyttes en spesiell \textbf{printcap}-fil som kun eksponerer ``followme''-utskriftskÞen til brukere. 
    263 Se \texttt{doc/Samba/printcap}. 
    264  
    265  
    266 \subsection{Autentisering} 
    267 Samba autentiserer brukere mot LDAP. 
     251You should use a special \textbf{printcap} file that only exposes the ``followme'' print queue to users. 
     252See \texttt{doc/Samba/printcap}. 
     253 
     254\subsection{Authentication} 
     255Samba authenticates users against LDAP. 
    268256 
    269257 
    270258\subsection{Windows Vista} 
    271259 
    272 Windows Vista har en brukken implementasjon av IPPS, IPP over SSL. 
    273 Derfor mÃ¥ Samba brukes, og skriveren legges til som en ``delt skriver, etter navn''. 
    274 Se brukerdokumentasjonen for Ã¥ legge til skriveren i Windows Vista. 
    275  
    276  
    277 \section{Integrasjon mot Active Directory} 
    278  
    279 Ved integrasjon mot Active Directory (AD) endres oppsettet noe. 
    280  
    281 Man trenger ikke lenger Ã¥ konfigurere opp Samba og CUPS med integrasjon mot LDAP og pam\_ldap. 
    282 I stedet setter man opp Samba til Ã¥ autentisere direkte mot AD, bruker Winbind for Ã¥ mappe opp navn pÃ¥ brukere og grupper til brukernummere, som POSIX-systemer avhenger av, og Kerberos for autentisering (og Single Sign On) av brukere pÃ¥ maskiner tilknyttet Windows-domenet. 
    283  
    284 Se de kommenterte eksemplene merket med ``For Active Directory'' i \texttt{doc/Samba/smb.conf} for Ã¥ konfigurere Samba mot AD, \texttt{doc/PAM/cupsys} for Ã¥ konfigurere CUPS sin PAM-konfigurasjon for Ã¥ autentisere mot Winbind og \texttt{doc/NSSWITCH/nsswitch.conf} for Ã¥ konfigurere nsswitch. 
    285  
    286 Verifiser oppsettet av Winbind med kommandoen \textbf{wbinfo -u}. 
    287 Denne skal liste ut alle brukerne fra AD. 
    288  
    289 Man trenger dermed ikke Ã¥ konfigurere opp \texttt{/etc/ldap.conf} og \textbf{pam\_ldap}. 
    290  
    291  
    292 \section{KvoteverktÞy} 
    293 For Ã¥ gjÞre batch-oppdatering av kvote til en gruppe med brukere, sÃ¥ kan skriptet \texttt{src/Followme/script/bifrost-quota.pl} brukes. 
    294 Denne tar et sett med parametere, og kaller videre pÃ¥ Bifrost som gjÞr jobben. 
    295  
    296 Skriptet mÃ¥ kjÞres fra samme maskin som Bifrost kjÞrer pÃ¥ eller fra en maskin i subnettet som brukes til identitetsenheter. 
    297 Med andre ord, adressen til maskinen mÃ¥ vÊre konfigurert i cardreaders-seksjonen i \textbf{followme.yml}. 
    298  
    299 Skriptet tar fÞlgende parametere: 
    300 \begin{itemize} 
    301  \item \textbf{--url URL} Nettadresse til Bifrost backend som styrer kvoter. For eksempel: \texttt{http://localhost/backend/quota/reset\_quota}. 
    302  \item \textbf{--ldap-filter FILTER} Et LDAP-filter som brukes for Ã¥ lete opp brukere som skal fÃ¥ ny kvote. Filteret ``(objectClass=person)'' blir automatisk lagt til i sÞket. 
    303  \item \textbf{--quota QUOTA} Ny kvote som skal settes pÃ¥ matchende brukere. Dette mÃ¥ vÊre et heltall. 
    304  \item \textbf{--initial-quota QUOTA} Ny initiell kvote som skal settes pÃ¥ matchende brukere. Dette mÃ¥ vÊre et heltall. Denne endrer ikke kvoten til brukerne, men nÃ¥r opsjonen \textbf{--reset-quota} brukes vil ny kvote bli satt til den initielle kvoten for hver bruker. 
    305  \item \textbf{--reset-quota} Setter den initielle kvoten som gjeldende kvote pÃ¥ matchende brukere. 
    306  \item \textbf{--dry-run} Ingen endringer gjÞres pÃ¥ kvoten. En liste over brukere som ville blitt berÞrt blir printet ut. Nyttig for testing av LDAP-filteret. 
    307  \item \textbf{--timeout SECONDS} Maks antall sekunder som skriptet skal vente pÃ¥ respons fra Bifrost. 
    308  \item \textbf{--help} Gir en hjelpende hÃ¥nd. 
     260Windows Vista has a broken implementation of IPPS, IPP over SSL. 
     261As a consequence, you need to use Samba, and add the printer as a ``shared printer, by name''. 
     262See the user documentation for information on how to add the printer in Windows Vista. 
     263 
     264\section{Integration with Active Directory} 
     265 
     266Integrating with Active Directory (AD) will imply slight changes to the setup. 
     267 
     268You no longer need to configure Samba and CUPS with LDAP and pam\_ldap integration. 
     269Instead, configure Samba to authenticate directly with AD, use Winbind to map user and group names with user numbers that POSIX systems depend on, and Kerberos for authenticating (and Single Sign On for) users on computers in Windows domains. 
     270 
     271See the commented examples labelled ``For Active Directory'' in \texttt{doc/Samba/smb.conf} to configure Samba with AD, \texttt{doc/PAM/cupsys} to configure CUPS' PAM configuration to authenticate with Winbind, and \texttt{doc/NSSWITCH/nsswitch.conf} to configure nsswitch. 
     272 
     273Verify the Winbind setup with the \textbf{wbinfo -u} command. 
     274This should list all users from AD. 
     275 
     276As a result, you do not need to configure \texttt{/etc/ldap.conf} and \textbf{pam\_ldap}. 
     277 
     278 
     279\section{Quota tool} 
     280In order to run batch updates of quotas for a group of users, you can use the \texttt{src/Followme/script/bifrost-quota.pl} script. 
     281This script takes one set of parameters, and calls on Bifrost to do the actual job. 
     282 
     283You must run the script from the computer running Bifrost or from a computer in the subnet used for identity units. 
     284In other words, the computer's address must be configured in the card readers section of \textbf{followme.yml}. 
     285 
     286The script takes the following parameters: 
     287\begin{itemize} 
     288 \item \textbf{--url URL} Net address for Bifrost back-end controlling quotas. Example: \texttt{http://localhost/backend/quota/reset\_quota}. 
     289 \item \textbf{--ldap-filter FILTER} An LDAP filter used for tracking users who you want to assign a new quota to. The  ``(objectClass=person)'' filter will automatically be added in the search. 
     290 \item \textbf{--quota QUOTA} New quota to be assigned to matching users. This must be an integer. 
     291 \item \textbf{--initial-quota QUOTA} New initial quota to be assigned to matching users. This must be an integer. This does not modify the users' quotas, but when using the \textbf{--reset-quota} option, the new quota will be set to the initial quota for each user. 
     292 \item \textbf{--reset-quota} Sets the initial quota as the current quota for matching users. 
     293 \item \textbf{--dry-run} No quota changes. Prints a list of users that would have been affected. useful for testing the LDAP filter. 
     294 \item \textbf{--timeout SECONDS} The maximum number of seconds the script will wait for response from Bifrost. 
     295 \item \textbf{--help} Offers a helping hand. 
    309296\end{itemize} 
    310297 
    311298\begin{quotation} 
    312 VIKTIG
    313 \textbf{--reset-quota} og \textbf{--quota} kan ikke brukes samtidig, fordi begge opsjonene brukes for Ã¥ endre brukerens gjeldende kvote
     299IMPORTANT
     300\textbf{--reset-quota} and \textbf{--quota} cannot be used simultaneously, since both options are used for change the user's current quota
    314301\end{quotation} 
    315302 
    316  
    317 \section{Lokalisering og oversetting} 
    318 Nettsidene er tilgjengelig pÃ¥ bÃ¥de engelsk og norsk bokmÃ¥l. 
    319 Det er nettleseren som bestemmer hvilket sprÃ¥k som skal benyttes ved Ã¥ sende headeren ``Accept-Languages''. 
    320 Norsk fÃ¥r man nÃ¥r nettleseren er konfigurert til Ã¥ akseptere sprÃ¥ket ``no''. Engelsk er forhÃ¥ndsvalgt dersom nettleseren ikke sender denne headeren. 
     303\section{Localization and translation} 
     304The web pages are available in both English and Norwegian (bokmÃ¥l). 
     305The web browser determines which language version to use, by submitting the ``Accept-Languages'' header. 
     306Norwegian is selected when the web browser has been configured to accept ``no'' as language. English is the default language if the browser does not submit this header. 
    321307 
    322308\subsection{Gettext} 
    323 Oversettelsesfilene finnes under \texttt{src/Followme/lib/Followme/I18N/} og har filendelse ``.po''. 
    324 De kompilerte filene har filendelse ``.mo''. 
    325  
    326 Redigeringsprogrammet poEdit\footnote{poEdit kan brukes for Ã¥ endre oversettelsesfiler. http://poedit.sourceforge.net/} er godt egnet for Ã¥ redigere disse filene. Denne vil oppdatere mo-filen nÃ¥r po-filen lagres
     309The translation files are found under \texttt{src/Followme/lib/Followme/I18N/}, with file extension ``.po''. 
     310The compiled files have file extension ``.mo''. 
     311 
     312The poEdit\footnote{poEdit can be used for editing translation files. http://poedit.sourceforge.net/} editor is suitable for translating these files. The editor will update the mo file when the po file is stored
  • trunk/doc/userdoc/en/error-situations.tex

    r704 r998  
    1 \chapter{Feilsituasjoner
     1\chapter{Error situations
    22 
    3 \section{Utskriften min kommer ikke
     3\section{My document is not printed
    44 
    5 Det kan vÊre flere grunner til at utskriften din ikke kommer. Her beskrives de mest aktuelle. Dersom du fortsatt har problemer, vennligst ta kontakt med din systemadministrator. 
     5The most common causes for documents not being printed are described below. If you still have problems producing the printed document, please contact your system administrator. 
    66 
    77 
    8 \subsection{Kortet ditt ble lest feil
     8\subsection{Your card was not read correctly
    99 
    10 PrÞv Ã¥ dra kortet en gang til. Dersom lampa pÃ¥ kortleseren lyser rÞdt etter du har dratt kortet er kortet ditt blitt lest feil. PrÞv derfor Ã¥ dra kortet saktere igjennom kortleseren og pass pÃ¥ at hele kortet blitt dratt igjennom leseren
     10Try swiping the card again. The card reader light will be red if the card is not read correctly. Try swiping the card more slowly through the card reader, and make sure the whole card is read
    1111 
    12 Kortleseren kan bare lese magnetstripe pÃ¥ den ene siden av kortet. PrÞv derfor Ã¥ snu kortet, og dra det igjen
     12The card reader can only read the magnetic field on one side of the card. Try swiping the card the other way.
    1313 
    1414 
    15 \subsection{Ingen utskriftsjobber
     15\subsection{No print jobs
    1616 
    17 Er du sikker pÃ¥ at du har skrevet ut noen dokumenter til ``followme''-kÞen? Utskriftsjobber som er eldre enn en viss tid vil bli fjernet. Denne tiden vil normalt vÊre satt til 7 timer. ForhÞr deg med administrasjonen om hvor lenge denne tiden er satt
     17Are you sure you have submitted documents to the ``followme'' queue? Print jobs are automatically deleted by the system if they have remained in the followme queue for a while, e.g. 7 hours. Ask your system administrator about the time limit for print jobs
    1818 
    1919 
    20 \subsection{Ikke nok kvote igjen
     20\subsection{Insufficient quota
    2121 
    22 Bifrost benytter et kvotesystem som gir brukerne en bestemt mengde utskriftskvote. Dersom du ikke har nok utskriftskvote igjen for dokumentet du har skrevet ut, vil ikke dokumentet bli skrevet ut. Du vil motta en e-post om dette
     22Bifrost uses a quota system to restrict the number of print jobs allowed for each user. If your remaining quota is insufficient for the document you wanted to print, it will not be printed. An e-mail message is submitted to users who run out of print quotas
  • trunk/doc/userdoc/en/introduction.tex

    r905 r998  
    1 \chapter{Innledning
     1\chapter{About Bifrost
    22 
    3 ``Bifrost'' er navnet pÃ¥ utskriftssystemet utviklet av Redpill Linpro AS. 
     3``Bifrost'' is the name of the printing solution developed by Redpill Linpro AS. 
    44 
     5\section{Introduction} 
    56 
    6 \section{Introduksjon} 
     7Before Bifrost, you had to register every printer in every school with the appropriate driver for each printer. 
     8With Bifrost, adding one printer on your PC enables you to perform the printing on all printers you have physical access to. \footnote{The printers must be connected to the Bifrost system}. 
     9You can use Linux, Windows and MAC OS X for printing with Bifrost. 
    710 
    8 Tidligere har man mÃ¥tte legge til alle skriverne med riktig driver for hver skriver pÃ¥ alle PC-ene. 
    9 Med Bifrost trenger du bare Ã¥ legge til én skriver pÃ¥ PC-en din, og dette gjÞr det mulig Ã¥ skrive ut pÃ¥ hvilken som helst skriver du fysisk har tilgang til\footnote{Forbeholdt at skriveren er tilknyttet Bifrost-systemet}. 
    10 Du kan benytte Linux, Windows eller MAC OS X for Ã¥ skrive ut med Bifrost. 
     11When you send a document to this printer, the print job is submitted to a print queue. Using the magnetic card you have received, you can have your document printed by swiping the card in the card reader connected to the printer you want to use.  
     12The document is printed on the printer. (If you have not received a card, contact your system administrator). 
    1113 
    12 NÃ¥r du skriver ut et dokument til denne skriveren blir utskriftsjobben lagt i en kÞ. 
    13 Du som bruker skal ha fÃ¥tt tildelt et kort med magnetstripe (hvis ikke, ta kontakt med systemansvarlig). 
    14 NÃ¥r du vil hente utskriften din, gÃ¥r du til nÊrmeste skriver og drar kortet i den tilknyttede kortleseren. 
    15 Utskriften blir deretter umiddelbart skrevet ut pÃ¥ skriveren. 
     14The solution architecture allows you to print your print job on any of the printers connected to the Bifrost server, including printers in other buildings or other schools. 
    1615 
    17 Det stÃ¥r en kortleser koblet til alle skriverne, og nÃ¥r du drar kortet ditt vil alle utskrifter du har sendt til ``followme''-kÞen bli skrevet ut pÃ¥ den skriveren som er koblet til kortleseren du dro kortet i. 
     16It is also possible to install Bifrost with numeric keypads (numpad) instead of card readers. 
     17On numpads, users identify themselves with a pin code instead of a magnetic card. 
    1818 
    19 Det er ogsÃ¥ mulig Ã¥ installere Bifrost med numpad istedenfor kortlesere. 
    20 Brukerne benytter dermed seg av en pinkode for Ã¥ identifisere seg, istedenfor et magnetkort. 
     19The solution architecture allows you to pick up your printout on any printer connected to the Bifrost server. The printer may be located in a different room, in a different building, or even a different country. 
    2120 
    22 Grunnet arkitekturen av lÞsningen vil det vÊre mulig Ã¥ hente utskriften din pÃ¥ en hvilken som helst skriver tilknyttet Bifrost-tjeneren. 
    23 Det kan vÊre i et annet rom eller en annen bygning, eller det kan faktisk vÊre et annet land. 
     21\section{License} 
    2422 
    25  
    26 \section{Lisens} 
    27  
    28 Bifrost er utgitt under betingelsene til GNU GPL versjon 2\footnote{GNU GPL versjon 2 finnes pÃ¥ http://www.gnu.org/licenses/gpl-2.0.html}. 
    29 Du finner en kopi av lisensen i fila ``LICENSE'' pÃ¥ rota av prosjektetkatalogen. 
     23Bifrost is licensed in accordance with GNU GPL version 2\footnote{Read more about GNU GPL version 2 on http://www.gnu.org/licenses/gpl-2.0.html}. 
     24A copy of the license is found in the ``LICENSE'' file on the project catalog root. 
  • trunk/doc/userdoc/en/printer-setup.tex

    r919 r998  
    1 \chapter{Skriveroppsett
    2  
    3 PÃ¥ Bifrost-tjeneren finnes det en utskriftskÞ som heter ``followme'' som du legger til som skriver pÃ¥ din PC. 
    4  
    5 MÃ¥ten man legger til skriveren er forskjellig avhengig av ditt valg av operativsystem
    6  
    7  
    8 \section{Adresse til utskriftskÞ
     1\chapter{Printer setup
     2 
     3The Bifrost server contains a print queue called ``followme'', which you add as a printer on your PC.  
     4 
     5Your operating system will determine your method for adding a printer
     6 
     7 
     8\section{Print queue address
    99\label{sec:address-followme-queue} 
    1010 
    11 Adresse til utskriftskÞen ``followme'' baserer seg pÃ¥ fÞlgende format. 
     11The ``followme'' print queue address is based on the following format: 
    1212 
    1313\begin{verbatim} 
    14  ipp://<brukernavn>:<passord>@<server>:631/printers/followme 
     14 ipp://<username>:<password>@<server>:631/printers/followme 
    1515\end{verbatim} 
    1616 
    17 Bytt ut \textbf{<brukernavn>} og \textbf{<passord>} med ditt eget brukernavn og passord. Bytt sÃ¥ ut \textbf{<server>} med adressen til utskriftstjeneren. HÞr med din systemadministrator om korrekt adresse til denne tjeneren
    18  
    19 Adressen som benyttes pÃ¥ Windows-maskiner ser noe annerledes ut, da et annet portnummer enn 631 mÃ¥ benyttes for Ã¥ tvinge fram bruk av SSL for kryptering
    20  
    21  
    22 \section{Oppsett pÃ¥ Windows
    23  
    24 PÃ¥ Windows legger man til skriveren med IPP. Dette krever at man kobler til serveren med SSL/TLS-stÞtte aktivert. 
    25  
    26  
    27 \subsection{Konfigurasjon} 
     17Replace \textbf{<username>} and \textbf{<password>} with your own user name and password. Replace \textbf{<server>} with the print server address - your system administrator may be able to supply one
     18 
     19The address used on Windows computers looks slightly different; a different port number must be used to enforce SSL for encryption
     20 
     21 
     22\section{Windows setup
     23 
     24On Windows computers, you add the printer using IPP. This requires a connecting to the server with activated SSL/TLS support. 
     25 
     26 
     27\subsection{Configuration} 
    2828 
    2929\begin{enumerate} 
    3030 
    31  \item GÃ¥ til innstillinger for skrivere. 
    32  
    33   Navigér deg fram til innstillinger for ``Skrivere'' i ``Kontrollpanelet''. 
    34  
    35   \begin{verbatim} 
    36    Eksempel fra engelsk versjon av Windows: 
    37     Start -> Settings -> Printers and Faxes 
    38   \end{verbatim} 
    39  
    40  
    41  \item Legg til skriver 
    42  
    43   Legg til en nettverksskriver. Velg at du Þnsker Ã¥ legge til en sÃ¥kalt ``Internett-skriver''. 
    44  
    45   \begin{verbatim} 
    46    Eksempel fra engelsk versjon av Windows: 
    47     Add Printer -> Next 
    48       -> A network printer... -> Next 
    49       -> Connect to a printer on the Internet... 
    50   \end{verbatim} 
    51  
    52  
    53  \item Skriv inn URL til followme-kÞen 
    54  
    55   Skriv inn URL-en nedenfor som ``Vertsnavn eller IP-adresse'' til skriveren. 
    56   I Windows Vista lar du ``Enhetstype'' vÊre satt til ``Identifiser automatisk''. 
    57  
    58   Bemerk portnummeret som er porten som brukes for SSL-tilkobling. Windows stÞtter ikke automatisk bytte til SSL, sÃ¥ dette mÃ¥ settes eksplisitt. 
    59   Skriv inn fÞlgende adresse til skriveren og gÃ¥ videre. 
    60  
    61   \begin{verbatim} 
    62    https://server:10443/printers/followme 
    63   \end{verbatim} 
    64  
    65   Bytt ut \textbf{server} med korrekt adresse til utskriftstjeneren. 
    66   HÞr med din systemadministrator om korrekt adresse til denne tjeneren. 
    67  
    68  
    69   \begin{quotation} 
    70    \textbf{VIKTIG OM WINDOWS VISTA} 
    71     Vi hadde problemer med Ã¥ fÃ¥ Windows Vista til Ã¥ benytte seg av SSL i kommunikasjon med CUPS og kan derfor ikke bruke IPP. 
    72  
    73     I Windows Vista nÃ¥r det sÞkes etter en skriver velger du at skriveren du legger til ikke er listet. 
    74     Velg sÃ¥ at du Þnsker Ã¥ legge til en ``delt skriver, etter navn''. 
    75     Skriv sÃ¥ inn fÞlgende URL og gÃ¥ videre: 
    76     \begin{verbatim} 
    77      \\server\followme 
    78     \end{verbatim} 
    79  
    80   \end{quotation} 
    81  
    82  
    83  \item Registrer informasjon om port 
    84  
    85   Dialogboksen ``Konfigurere Internett port'' skal nÃ¥ vises. 
    86   Velg ``Bruk spesifisert brukerkonto'' og skriv inn ditt brukernavn og passord til kontoen du har fÃ¥tt utdelt pÃ¥ skolen. 
    87  
    88   \begin{verbatim} 
    89    Eksempel fra engelsk versjon av Windows: 
    90     Configure Internet Port 
    91       -> Use the specified user account 
    92   \end{verbatim} 
    93  
    94  
    95  \item Velg driver 
    96  
    97   Velg en ``PostScript''-driver. 
    98   Windows har ikke noen ren PostScript-driver, men du kan velge en annen driver med PostScript-funksjonalitet som for eksempel ``HP LaserJet 2100 Series PS''. 
     31 \item Open the printer settings. 
     32 
     33  Navigate to the ``Printers'' settings in the ``Control panel''. 
     34 
     35  \begin{verbatim} 
     36    Start -> Settings -> Printers and Faxes 
     37  \end{verbatim} 
     38 
     39 
     40 \item Add printer 
     41 
     42  Add a network printer. Specify that you wish to add an ``Internet printer''. 
     43 
     44  \begin{verbatim} 
     45    Add Printer -> Next 
     46      -> A network printer... -> Next 
     47      -> Connect to a printer on the Internet... 
     48  \end{verbatim} 
     49 
     50 
     51 \item Enter the URL for the followme queue 
     52 
     53  Enter the URL below as the printer's ``Host name or IP address''. 
     54  For Windows Vista, set ``Unit type'' to ``Identify automatically''. 
     55 
     56  Please note the port number representing the port used for SSL connection. Windows does not support automatic change to SSL, so you need to set this manually. 
     57  Enter the following printer address and proceed. 
     58 
     59  \begin{verbatim} 
     60   https://server:10443/printers/followme 
     61  \end{verbatim} 
     62 
     63  Replace \textbf{server} with the actual address of the print server. Ask your system administrator for the server address. 
     64 
     65 
     66  \begin{quotation} 
     67   \textbf{IMPORTANT ABOUT WINDOWS VISTA} 
     68    We encountered a few problems trying to make Windows Vista use SSL in its communication with CUPS, and as a result, IPP cannot be used. Next, specify that you want to add a ``shared printer, by name''. Enter the following URL and proceed. 
     69    \begin{verbatim} 
     70     \\server\followme 
     71    \end{verbatim} 
     72 
     73  \end{quotation} 
     74 
     75 
     76 \item Register port information 
     77 
     78  The ``Configure Internet port'' dialog box is displayed. 
     79  Select ``Use the specified user account'' and enter your user name and password for the account you were given by your school/organization. 
     80 
     81  \begin{verbatim} 
     82    Configure Internet Port 
     83      -> Use the specified user account 
     84  \end{verbatim} 
     85 
     86 
     87 \item Select driver 
     88 
     89  Select a ``PostScript'' driver. 
     90  Windows does not have a specific PostScript driver, but you can select another driver with PostScript functionality, for instance ``HP LaserJet 2100 Series PS''. 
    9991 
    10092\end{enumerate} 
    10193 
    10294 
    103 \subsection{Printerdrivere} 
    104 FÞlgende printerdrivere er testet og kan brukes pÃ¥ Windows-klienter: 
    105 \begin{itemize} 
    106  \item HP LaserJet 2100 Series PS (svart/grÃ¥toner) 
    107  \item HP Color LaserJet PS (farger) - anbefales 
    108 \end{itemize} 
    109  
    110  
    111  
    112 \section{Oppsett pÃ¥ OS X} 
    113  
    114 PÃ¥ Mac OS X legger man til skriveren med Samba\footnote{Samba er en implementasjon av Microsoft Windows Fil- og Skriverdeling}. 
    115  
    116 Under innstillinger for skrivere, klikk ``options+More Printers'' og ``Windows Printing''. SÞk frem Bifrost-tjeneren og velg ``followme''-skriveren og legg til denne. 
    117  
    118 OS X vil vise en dialogboks hvor du skriver inn ditt brukernavn og passord. 
     95\section{OS X setup} 
     96 
     97On Mac OS X, you add the printer using Samba\footnote{Samba is an implementation of Microsoft Windows File and Printer Sharing}. 
     98 
     99In the printer settings section, click ``options+More Printers'' and ``Windows Printing''. Locate the Bifrost server, and select and add the ``followme'' printer. 
     100 
     101OS X displays a dialog box where you enter your user name and password. 
    119102 
    120103\begin{quote} 
    121  OBS: Mac OS X 10.5 skal tilsynelatende stÞtte IPP med vising av dialogboks for autentisering
     104 NOTE: Mac OS X 10.5 is reported to support IPP with an authentication dialog box
    122105\end{quote} 
    123106 
    124107 
    125 \section{Oppsett pÃ¥ Linux
    126  
    127 PÃ¥ Linux er det forskjellige mÃ¥ter Ã¥ legge til skriveren pÃ¥. Den stÞtter skrivere koblet til over bÃ¥de Samba og IPP, men vi velger Ã¥ gÃ¥ for IPP. 
    128  
    129 Verken Gnome og KDE vil vise en dialogboks hvor du kan skrive inn ditt brukernavn og passord, sÃ¥ i Linux mÃ¥ du fÞre inn brukernavnet og passordet ditt i adressen til skriveren. BÃ¥de Gnome og KDE har grafiske veivisere for Ã¥ legge til skrivere. (Noen distribusjoner vil kunne vise deg dialogboks for brukernavn og passord, men vÃ¥re tester feilet pÃ¥ dette omrÃ¥det.) 
    130  
    131 \subsection{lpadmin fra kommandolinje} 
    132  
    133 Dersom du er kjent med Linux kan du selv legge til skriveren fra terminalen med kommandoen lpadmin
     108\section{Linux setup
     109 
     110On Linux, there are a number of ways of adding a printer. Both Samba and IPP connection is supported, but we have decided to go for IPP. 
     111 
     112Neither Gnome nor KDE will display a dialog box to enter your user name and password; in Linux you need to include your user name and password in the printer address. Both Gnome and KDE offer a graphical interface for adding printers. (Some distributions may be able to show you a dialog box for user name and password, but our tests were unsuccessful.) 
     113 
     114\subsection{lpadmin from command line} 
     115         
     116If you are familiar with Linux, you will be able to add the printer from the terminal, using the lpadmin command
    134117 
    135118\begin{verbatim} 
    136119# lpadmin -p followme -E \ 
    137 > -v 'ipp://brukernavn:passord@server:631/printers/followme' 
     120> -v 'ipp://username:password@server:631/printers/followme' 
    138121\end{verbatim} 
    139122 
    140 Bytt ut \textbf{brukernavn} og \textbf{passord} med ditt eget brukernavn og passord. \textbf{server} er adressen til utskriftstjeneren. HÞr med din systemadministrator om korrekt adresse til denne tjeneren. 
    141  
    142  
    143 \subsection{Linux med Gnome} 
    144  
    145 Gnome har et grafisk grensesnitt for Ã¥ administrere skrivere. Dette er tilgjengelig fra menyen pÃ¥ verktÞylinjen under ``System'', ``Administrasjon'', ``Skrivere''. 
     123Replace \textbf{<username>} and \textbf{<password>} with your own user name and password. Replace \textbf{<server>} with the print server address - your system administrator may be able to help. 
     124 
     125\subsection{Linux with Gnome} 
     126 
     127Gnome offers a graphical interface for managing printers, available from the toolbar menu: ``System'' > ``Administration'', ``Printers''. 
    146128 
    147129\begin{enumerate} 
    148  \item Klikk ``Ny skriver'' 
    149  
    150   \begin{verbatim} 
    151    Eksempel fra engelsk versjon av Gnome: 
    152     New Printer 
    153   \end{verbatim} 
    154  
    155  
    156  \item Velg ``annet'' og skriv inn adressen til skriveren 
    157  
    158   Adressen som skal brukes er forklart i seksjon \ref{sec:address-followme-queue}. 
    159  
    160  
    161  \item Velg ``generell'' og klikk neste 
    162  \item Velg ``PostScript'' og klikk neste 
    163  \item Skriv inn navnet til skriveren 
    164  
    165   Dette navnet velger du selv, og kan for eksempel vÊre ``molde.followme''. 
    166   Hvis du Þnsker, kan du skrive inn en beskrivelse og plassering av skriveren, for eksempel henholdsvis ``Bifrost follow-me'' og ``Molde''. 
     130 \item Click ``New printer'' 
     131 
     132  \begin{verbatim} 
     133    New Printer 
     134  \end{verbatim} 
     135 
     136 
     137 \item Select ``other'' and enter the printer address 
     138 
     139  Use the address described in section \ref{sec:address-followme-queue}. 
     140 
     141 
     142 \item Select ``General'' and click Next 
     143 \item Select ``PostScript'' and click Next 
     144 \item Enter the printer name 
     145 
     146  You can make up this name yourself, for instance ``molde.followme''. 
     147  Optionally, you can also enter a description and location for the printer, for instance ``Bifrost follow-me'' and the geographic location. 
    167148\end{enumerate} 
    168149 
    169150 
    170151 
    171 \subsection{Linux med KDE} 
    172  
    173 KDE har ogsÃ¥ et grafisk grensesnitt for Ã¥ administrere skrivere. Dette er tilgjengelig fra K-menyen under ``Systeminnstillinger'' og ``Skrivere''. 
     152\subsection{Linux with KDE} 
     153 
     154KDE also offers a graphical interface for managing printers, available from the K menu: ``System settings'' > ``Printers''. 
     155 
    174156 
    175157\begin{enumerate} 
    176  \item Klikk ``Legg til'' og ``Legg til skriver/klasse'' 
    177  
    178   \begin{verbatim} 
    179    Eksempel fra engelsk versjon av KDE: 
    180     Add -> Add Printer/Class 
    181   \end{verbatim} 
    182  
    183  
    184  \item Velg CUPS server (IPP/HTTP) og klikk neste 
    185  
    186   \begin{verbatim} 
    187    Eksempel fra engelsk versjon av KDE: 
    188     Remote CUPS server (IPP/HTTP) 
    189   \end{verbatim} 
    190  
    191  
    192  \item Skriv inn brukerinfo 
    193  
    194   Velg ``vanlig konto'' og skriv inn ditt brukernavn og passord 
    195  
    196   \begin{verbatim} 
    197    Eksempel fra engelsk versjon av KDE: 
    198     Normal Account 
    199   \end{verbatim} 
    200  
    201  
    202  \item Skriv inn adressen til utskriftstjeneren 
    203  
    204   Skriv inn adressen til utskriftstjeneren, og la portnummeret vÊre \textbf{631}. HÞr med din systemadministrator om korrekt adresse. 
    205  
    206  
    207  \item Velg skriver 
    208  
    209   Velg skriveren ``followme'' og klikk neste. 
    210  
    211  
    212  \item Velg PostScript-driveren 
    213  
    214   Merk av for ``PostScript skriver'' og trykk neste. 
     158 \item Click ``Add'' and ``Add Printer/Class'' 
     159 
     160  \begin{verbatim} 
     161    Add -> Add Printer/Class 
     162  \end{verbatim} 
     163 
     164 
     165 \item Select CUPS server (IPP/HTTP) and click Next 
     166 
     167  \begin{verbatim} 
     168    Remote CUPS server (IPP/HTTP) 
     169  \end{verbatim} 
     170 
     171 
     172 \item Enter user information 
     173 
     174  Select ``Normal account'' and enter your user name and password 
     175 
     176  \begin{verbatim} 
     177    Normal Account 
     178  \end{verbatim} 
     179 
     180 
     181 \item Enter the print server address 
     182 
     183  Enter the print server address; and \textbf{631} for port number. Ask your system administrator for the appropriate address. 
     184 
     185 
     186 \item Select printer 
     187 
     188  Select the ``followme'' printer and click Next. 
     189 
     190 
     191 \item Select PostScript driver 
     192 
     193  Select ``PostScript printer'' and click Next. 
    215194 
    216195\begin{quote} 
    217  OBS: Det kan ta litt tid fÞr listen over drivere blir lastet ferdig
     196 NOTE: The listing of drivers may take a little time
    218197\end{quote} 
    219198 
    220199 
    221  \item Skriv inn navn pÃ¥ skriveren 
    222  
    223   Klikk neste til du kommer til et skjema for Ã¥ skrive inn navn pÃ¥ skriveren. Klikk sÃ¥ neste. Klikk til slutt ``Ferdig''
     200 \item Enter the printer name 
     201 
     202  Click Next until a form prompts you for the printer name. Click next. Finally, click ``Ferdig'' ??Done? Finished? Complete??
    224203 
    225204\end{enumerate} 
     
    227206 
    228207 
    229 \section{Teste skriveroppsett
    230  
    231 Du kan teste skriveroppsettet ditt ved Ã¥ skrive ut et dokument pÃ¥ den nyopprettede skriveren. Deretter gÃ¥r du til web-grensesnittet (se kapittel \ref{webinterface}) til Bifrost og logger inn med samme brukernavn og passord som du brukte da du la til skriveren
    232  
    233 Dersom utskriften var vellykket skal du se en utskrift i listen under informasjon om brukerkontoen din. Dersom du ikke Þnsker Ã¥ skrive ut dette dokumentet kan du kansellere utskriften her
     208\section{Test printer setup
     209 
     210You can test your printer setup by printing a document on the printer you have created. Next, log on to the Bifrost web interface (see the \ref{webinterface} chapter) with the same user name and password you used for adding the printer
     211 
     212If the printing is successful, a printout item will be displayed in your user account information list. If you do not wish to print the document, simply cancel the print job
  • trunk/doc/userdoc/en/userdocumentation.tex

    r905 r998  
    88 
    99% Title Page 
    10 \title{Bifrost 1.1 Brukerdokumentasjon} 
     10\title{Bifrost 1.1 User documentation} 
    1111\author{Redpill Linpro AS} 
    1212 
     
    1515 
    1616\begin{abstract} 
    17 Bifrost er et utskriftssystem utviklet av Linpro AS for MÞre og Romsdal Fylkeskommune og er utgitt under betingelsene til GNU GPL versjon 2. 
    18 LÞsningen benytter magnetkort, kortlesere og utskriftskvoter
    19 Alternativt for magnetkort og kortlesere kan numpad og pinkoder benyttes istedet
    20 Brukere forholder seg til én skriver pÃ¥ datamaskinen sin og kan hente utskriften sin pÃ¥ hvilken som helst skriver tilknyttet lÞsningen
    21 LÞsningen fungerer med Linux, Windows og MAC OS X og benytter seg av Postscript. 
     17Bifrost is a printing solution developed by Linpro AS for the MÞre and Romsdal county council in Norway, licensed in accordance with GNU GPL version 2. 
     18The solution is based on magnetic cards, card readers and print quotas
     19Numeric keypads and pin codes can be used instead of magnetic cards and card readers
     20Users send their print jobs to one generic printer, and can print the document on any printer connected to the system
     21The solution supports Linux, Windows and MAC OS X, and uses Postscript. 
    2222\end{abstract} 
    2323 
  • trunk/doc/userdoc/en/webinterface.tex

    r905 r998  
    1 \chapter{Webgrensesnitt
     1\chapter{Web interface
    22\label{webinterface} 
    33 
    4 Det er et webgrensesnitt for administrasjonen og brukerne av Bifrost
     4This is a web interface for Bifrost administrators and users
    55 
    6 \section{Innlogging
     6\section{Log-in
    77 
    8 Fordi administratorbrukere og vanlige brukere er lagret i forskjellige grener i LDAP-databasen, og dette brukes for Ã¥ skille deres roller, har administrasjonsbrukere en egen innloggingsside. Vanlige brukere logger inn pÃ¥ adressen \textbf{/login/}, mens administrasjonsbrukere logger inn pÃ¥ \textbf{/login/admins/}. 
    9 Det ligger ogsÃ¥ en link mellom disse to sidene under webskjemaet for innlogging
     8Since administrator users and ordinary users are stored in separate branches of the LDAP database, in order to separate their roles, administrator users have their own log-in page. Ordinary users log on to \textbf{/login/}, whereas administrator users use \textbf{/login/admins/}. 
     9There is a link between these pages in the log-in web form
    1010 
    1111 
    12 \section{Brukere
     12\section{Users
    1313 
    14 Under menyvalget ``Brukerstatus'' ser du informasjon om brukerkontoen din og hvor mye utskriftskvote du har igjen. I tillegg ser du en oversikt over utskriftsjobber som ligger i followme-kÞen, som venter pÃ¥ Ã¥ bli skrevet ut
     14The ``User status'' menu option displays information about your user account, including your remaining print quota. You'll also see an overview of print jobs in the followme queue, waiting to be printed
    1515 
    1616 
    17 \subsection{Utskriftsjobber
     17\subsection{Print jobs
    1818 
    19 Alle dokumenter du har skrevet ut pÃ¥ din datamaskin vises i en liste. Du har her mulighet til Ã¥ kansellere de jobbene du ikke Þnsker skrevet ut
     19Lists all documents you have sent to the print queue from your computer. You can cancel any jobs you do not wish to print after all
    2020 
    2121 
    2222 
    23 \section{Administrasjon
     23\section{Administrators
    2424 
    25 Brukere med administratorrettigheter har mulighet til Ã¥ administrere kvoter, kort og kortlesere
     25Users with administrator access rights can manage quotas, cards and card readers
    2626 
    2727 
    28 \subsection{Kortlesere
     28\subsection{Card readers
    2929 
    30 En kortleser identifiseres med sin MAC-adresse\footnote{En MAC-adresse er adressen til nettverkskortet som er unikt for alle nettverksenheter} som skal vÊre skrevet pÃ¥ undersiden av boksene. En kortleser kan enten vÊre tilknyttet en skriver eller vÊre frigjort slik at den kan brukes for administrasjon av kort. 
     30A card reader is identified by its MAC address\footnote{A MAC address is the address of the network card that is unique for all network units}, which you find printed on the bottom of the boxes. A card reader can either be connected to a printer or be used independently for card management. 
    3131 
    32 Man kan tildele kortlesere logiske navn som kan gjÞre det enklere Ã¥ identifisere og gjenkjenne kortlesere, for eksempel \textbf{Brick 1} eller \textbf{Molde Datarom - Lexmark C510} for Ã¥ vise at den er koblet til en gitt skriver pÃ¥ et gitt sted
     32You can assign logical names to card readers, in order to make it easier to identify and recognize them , for instance \textbf{Brick 1} or \textbf{Server room - Lexmark C510}, to show that it is connected to a specific printer at a specific location
    3333 
    3434 
    35 \subsection{Kort
     35\subsection{Cards
    3636 
    37 For Ã¥ administrere kort bÞr man ha tilgang til en administrasjonskortleser. Dette er pÃ¥krevd for Ã¥ registrere nye kort. Dette er ogsÃ¥ den enkleste mÃ¥ten for Ã¥ sÞke opp kort. Det er ogsÃ¥ mulig Ã¥ sÞke opp kort ved Ã¥ sÞke pÃ¥ deler av ID-en til kortet eller ved Ã¥ sÞke opp bruker og velge kortet fra brukerens egen liste over kort. 
    38  
    39 \subsubsection{Administrasjonskortlesere} 
    40  
    41 Her fÞlger beskrivelse for Ã¥ velge administrasjonskortleser. 
    42  
    43 Etter man logger inn, gÃ¥r man til \textbf{Administrasjon} og \textbf{Kort} og klikker pÃ¥ linken ``dra det'' under sÞkefeltet. 
    44 SÞk deretter opp kortleseren du har i nÊrheten, for eksempel \textbf{Molde Bibliotek Administrasjon}. 
    45 Du kan sÞke etter deler av navnet pÃ¥ kortleseren eller eksakt treff pÃ¥ MAC-adressen. Klikk sÃ¥ pÃ¥ linken ``Velg'' pÃ¥ Þnsket kortleser. 
    46  
    47 \subsubsection{SÞke opp kort} 
    48  
    49 Etter Ã¥ ha valgt kortleser for administrasjon kan man dra et kort i kortleseren. 
    50 Last dermed nettsiden pÃ¥ nytt og du vil se dataene fra kortet. Dersom kortet finnes fra fÞr i systemet har du muligheten til Ã¥ vise kortet. 
    51  
    52 \subsubsection{Opprette kort} 
    53  
    54 Dersom kortet du har dratt i kortleseren ikke finnes i systemet kan du nÃ¥ opprette kortet. 
    55 Du skriver inn en valgfri ID for kortet og trykker lagre. 
    56 Bemerk at ID-en pÃ¥ kortet \textbf{ikke} kan endres etter at kortet er opprettet. 
    57  
    58 \subsubsection{Sperre kort} 
    59  
    60 Det er mulig Ã¥ endre status pÃ¥ kortet for Ã¥ sperre dette. 
    61 Kort som \textbf{ikke} er \textbf{aktive} kan ikke brukes til utskrift. 
    62 NÃ¥r man deaktiverer et kort mÃ¥ man skrive inn en begrunnelse. 
    63 Dersom et kort er mistet kan (bÞr?) kortet fortsatt vÊre tilknyttet brukeren og kortets status settes sÃ¥ til ``Lost'', for Ã¥ beholde sporbarheten. 
     37Performing card management and registering new cards requires access to an administrator card reader. This is also the easiest way of identifying cards. You can also identify cards by searching for a part of the card ID or by searching for the user and select the card from the user's list of cards. 
    6438 
    6539 
    66 \subsection{Brukere
     40\subsubsection{Administrator card readers
    6741 
    68 Via \textbf{Administrasjon} og \textbf{Brukere} kan du enten sÞke opp brukere ved Ã¥ sÞke pÃ¥ eksakt eller deler av brukernavnet eller brukerens fulle navn. 
    69 Dersom man har sÞkt opp et kort vil man se hvem som er \textbf{kortholder} av kortet. 
     42To select an administrator card reader: 
    7043 
    71 NÃ¥r man ser pÃ¥ informasjon om brukeren vises ogsÃ¥ en liste over kort som er tildelt brukeren. 
     441. Log in 
     452. Select \textbf{Administration} and \textbf{Card}. 
     463. Click the ``drag it''?? link below the search field.  
     474. Search for a card reader nearby. You can search for parts of the card reader name or the exact MAC address.  
     485. Click the ``Select'' link for the card reader you want to select. 
    7249 
    73 \subsubsection{Utskriftskvote
     50\subsubsection{Search for a card
    7451 
    75 Alle brukere som tilknyttes et kort fÃ¥r automatisk utskriftskvote, for eksempel 500. Dette antallet er konfigurerbart og kan variere. 
    76 For Ã¥ legge til kvote til en bruker sÞker man opp brukeren og klikker linken ``Legg til'' ved siden av gjenstÃ¥ende kvote for brukeren. 
    77 Dersom man legger til for mye kvote er det mulig Ã¥ overstyre og sette ny kvote. 
     52After having selected an administrator card reader, you can swipe a card in the card reader. Reload the web page to display the card data. If the card is already registered on the system, you will be able to display the card. 
    7853 
    79 \subsubsection{Pinkoder
     54\subsubsection{Create a card
    8055 
    81 Alle brukere kan tilordnes en pinkode som kan brukes pÃ¥ en numpad-identitetsenhet for Ã¥ skrive ut sine utskrifter. 
    82 Dette kan vÊre istedenfor bruk av kort eller som et suplement. 
     56If the card you have swiped in the card reader has not been registered on the system, you can create the card now. Enter an optional ID for the card and click Save. NOTE: the card ID \textbf{cannot} be changed when the card has been created. 
    8357 
    84 Pinkoder er unike per bruker, som betyr at to brukere ikke kan tilordnes samme pinkode. 
     58\subsubsection{Deactivate card} 
     59 
     60It is possible to change the card status in order to block it from use. \textbf{Deactivated} cards can not be used for printing. When you deactivate a card, you need to specify a reason. If a card is lost, the card should still be associated with the user, and the card status set to ``Lost'', so it can still be tracked. 
    8561 
    8662 
    87 \section{SprÃ¥k
     63\subsection{Users
    8864 
    89 Brukergrensesnittet er oversatt til norsk bokmÃ¥l. 
    90 Valg av sprÃ¥k velges automatisk ut fra hvilket sprÃ¥k ditt operativsystem og nettleser er satt opp til. 
    91 BÃ¥de Internet Explorer og Firefox lar deg endre i innstillingene hvilke sprÃ¥k som er forvalgt. 
    92 For Ã¥ fÃ¥ norsk oversettelse med nettleseren Konqueror i KDE pÃ¥ Linux mÃ¥ du endre sprÃ¥ket i kontrollpanelet til KDE til norsk. 
     65Select \textbf{Administration} and \textbf{Users} to search for users, by typing a part of the user name or the user's complete name. When you find a match for a card, the \textbf{owner} of the card is displayed. 
     66 
     67User information also includes a list of cards issued to the user. 
     68 
     69\subsubsection{Print quota} 
     70 
     71All users to whom a card has been issued, automatically receive a print quota, for instance 500. The quota can be modified.  
     72To assign a quota to a user, search for the user and click the ``Add'' link next to the user's remaining quota. If you add too much, you can change the quota. 
     73 
     74\subsubsection{Pin codes} 
     75 
     76Pin codes can be assigned to all users, in order to identify themselves on numeric keypad (numpad) identity units when they wish to print their print jobs.  
     77Pin codes may be used either as a replacement of or a supplement to magnetic cards. 
     78 
     79Each user must has a unique pin code.  
     80 
     81 
     82\section{Language} 
     83 
     84The user interface is available in English and Norwegian. Bifrost automatically defaults to the language selected for your operating system and web browser. Both Internet Explorer and Firefox allows you to modify language selection. In order to run the English version in the Konqueror browser, select English in the KDE control panel.