| 1 |
dashley |
19 |
%$Header: /home/dashley/cvsrep/e3ft_gpl01/e3ft_gpl01/webprojs/pamc/gen_a/docs/manual/man_a/comps/workprfa.tex,v 1.9 2009/10/31 19:02:03 dashley Exp $
|
| 2 |
|
|
\chapter{Preface}
|
| 3 |
|
|
|
| 4 |
|
|
The product described in this document,
|
| 5 |
|
|
\emph{\productbasename{} Version \productversion{}}
|
| 6 |
|
|
(also called \emph{\productbasename{}-\productversion{}}),
|
| 7 |
|
|
is a free open-source server-based collaboration solution for
|
| 8 |
|
|
product development.
|
| 9 |
|
|
|
| 10 |
|
|
\emph{\productbasename{}-\productversion{}}
|
| 11 |
|
|
is a recipe for transforming
|
| 12 |
|
|
a \emph{*nix} server into a
|
| 13 |
|
|
product development collaboration platform.
|
| 14 |
|
|
\emph{\productbasename{}-\productversion{}} does provide
|
| 15 |
|
|
original content, but a large part of the functionality of
|
| 16 |
|
|
\emph{\productbasename{}-\productversion{}} is built
|
| 17 |
|
|
on other open-source products such as
|
| 18 |
|
|
\emph{*nix}, \emph{cvs}, \emph{svn}, \emph{PHP},
|
| 19 |
|
|
\emph{MySQL}, and \emph{putty}.
|
| 20 |
|
|
|
| 21 |
|
|
\emph{\productbasename{}-\productversion{}} provides the
|
| 22 |
|
|
following functionality:
|
| 23 |
|
|
|
| 24 |
|
|
\begin{itemize}
|
| 25 |
|
|
\item Secure access to \emph{*nix} shell accounts and
|
| 26 |
|
|
SFTP, secured by \emph{SSH} and \emph{CryptoCard} tokens.
|
| 27 |
|
|
\item Personal web space, secured by \emph{CryptoCard} tokens
|
| 28 |
|
|
used in conjunction with an \emph{Apache} authentication
|
| 29 |
|
|
module.
|
| 30 |
|
|
\item Version control, implemented via
|
| 31 |
|
|
\emph{cvs} and \emph{svn} and secured
|
| 32 |
|
|
via secure port forwarding and
|
| 33 |
|
|
\emph{putty}.
|
| 34 |
|
|
\item A general web database platform.
|
| 35 |
|
|
|
| 36 |
|
|
\begin{itemize}
|
| 37 |
|
|
\item The platform is secured with \emph{CryptoCard} tokens,
|
| 38 |
|
|
static passwords, IP restrictions, and \emph{https}.
|
| 39 |
|
|
\item The platform as installed provides substantial
|
| 40 |
|
|
useful functionality, including:
|
| 41 |
|
|
|
| 42 |
|
|
\begin{itemize}
|
| 43 |
|
|
\item User authentication and management.
|
| 44 |
|
|
\item E-mail notifications.
|
| 45 |
|
|
\item Employee time tracking and hours reporting.
|
| 46 |
|
|
\item Viewing of version control archives.
|
| 47 |
|
|
\item Document management.
|
| 48 |
|
|
\item Software defect tracking.
|
| 49 |
|
|
\item Automatic database maintenance.
|
| 50 |
|
|
\end{itemize}
|
| 51 |
|
|
|
| 52 |
|
|
\item The platform is designed to be easily extended by allowing
|
| 53 |
|
|
the addition of custom applications that operate in the same
|
| 54 |
|
|
authentication framework.
|
| 55 |
|
|
\end{itemize}
|
| 56 |
|
|
\end{itemize}
|
| 57 |
|
|
|
| 58 |
|
|
\emph{\productbasename{}-\productversion{}} can be used as-is, or individual
|
| 59 |
|
|
components can be harvested for use in other applications. For example,
|
| 60 |
|
|
the compiled \emph{C} program and \emph{PHP} functions that allow \emph{CryptoCard} tokens
|
| 61 |
|
|
to be used from \emph{PHP} may be useful in other applications.
|
| 62 |
|
|
|
| 63 |
|
|
\emph{\textbf{Part I: General Information}} provides introductory
|
| 64 |
|
|
and general information about the product.
|
| 65 |
|
|
|
| 66 |
|
|
\emph{\textbf{Part II: Technical Information}} provides a detailed
|
| 67 |
|
|
technical description of the product and its theory of operation.
|
| 68 |
|
|
|
| 69 |
|
|
\emph{\textbf{Part III: Installation and Maintenance}} provides an installation
|
| 70 |
|
|
guide for the product and instructions for maintaining the product.
|
| 71 |
|
|
\emph{\productbasename{}-\productversion{}}
|
| 72 |
|
|
is designed for use only on \emph{*nix} platforms.
|
| 73 |
|
|
|
| 74 |
|
|
\emph{\textbf{Part IV: User Information}} provides a
|
| 75 |
|
|
non-technical user manual for the product.
|
| 76 |
|
|
|
| 77 |
|
|
\emph{\textbf{Part V: Procedures and Checklists}} provides a
|
| 78 |
|
|
set of procedures and checklists to accomplish tasks where the
|
| 79 |
|
|
procedure or checklist didn't fit well into any other part of this
|
| 80 |
|
|
document.
|
| 81 |
|
|
|
| 82 |
|
|
\emph{\textbf{Part VI: Appendices, Bibliography, and Index}} provides
|
| 83 |
|
|
glossaries, references, and an index.
|
| 84 |
|
|
Individuals, products, companies, websites, and Internet newsgroups
|
| 85 |
|
|
are cited in the same framework
|
| 86 |
|
|
as traditional references in order to provide the reader with more
|
| 87 |
|
|
resources to obtain information.
|
| 88 |
|
|
|
| 89 |
|
|
The \emph{\productbasename{}-\productversion{}} software and all
|
| 90 |
|
|
associated materials are provided under open-source licenses; so all source
|
| 91 |
|
|
code is available and the product can be modified and/or distributed with
|
| 92 |
|
|
minimal restrictions.
|
| 93 |
|
|
|
| 94 |
|
|
Please feel free to contact me at \texttt{dashley@gmail.com} with
|
| 95 |
|
|
any suggestions for the \emph{\productbasename{}-\productversion{}}
|
| 96 |
|
|
product or associated documentation. If you require
|
| 97 |
|
|
assistance with the product, please refer to
|
| 98 |
|
|
\S{}\ref{ciov0:soas0} (p. \pageref{ciov0:soas0}).
|
| 99 |
|
|
|
| 100 |
|
|
I hope that this product is useful to you and that you
|
| 101 |
|
|
find it easy to install, use, maintain, and modify.
|
| 102 |
|
|
|
| 103 |
|
|
\vspace*{0.5in}
|
| 104 |
|
|
|
| 105 |
|
|
\noindent{}\hspace*{75mm}David T. Ashley \\
|
| 106 |
|
|
\hspace*{75mm}Marshall, Michigan, USA \\
|
| 107 |
|
|
\hspace*{75mm}November, 2009 \\
|
| 108 |
|
|
|
| 109 |
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
| 110 |
|
|
|
| 111 |
|
|
\noindent\begin{figure}[!b]
|
| 112 |
|
|
\noindent\rule[-0.25in]{\textwidth}{1pt}
|
| 113 |
|
|
\begin{tiny}
|
| 114 |
|
|
\begin{verbatim}
|
| 115 |
|
|
$RCSfile: workprfa.tex,v $
|
| 116 |
|
|
$Source: /home/dashley/cvsrep/e3ft_gpl01/e3ft_gpl01/webprojs/pamc/gen_a/docs/manual/man_a/comps/workprfa.tex,v $
|
| 117 |
|
|
$Revision: 1.9 $
|
| 118 |
|
|
$Author: dashley $
|
| 119 |
|
|
$Date: 2009/10/31 19:02:03 $
|
| 120 |
|
|
\end{verbatim}
|
| 121 |
|
|
\end{tiny}
|
| 122 |
|
|
\noindent\rule[0.25in]{\textwidth}{1pt}
|
| 123 |
|
|
\end{figure}
|
| 124 |
|
|
|
| 125 |
|
|
%$Log: workprfa.tex,v $
|
| 126 |
|
|
%Revision 1.9 2009/10/31 19:02:03 dashley
|
| 127 |
|
|
%Edits.
|
| 128 |
|
|
%
|
| 129 |
|
|
%Revision 1.8 2009/10/29 17:46:12 dashley
|
| 130 |
|
|
%Edits.
|
| 131 |
|
|
%
|
| 132 |
|
|
%Revision 1.7 2009/10/29 04:52:52 dashley
|
| 133 |
|
|
%Edits.
|
| 134 |
|
|
%
|
| 135 |
|
|
%Revision 1.6 2007/07/11 01:36:52 dashley
|
| 136 |
|
|
%Edits.
|
| 137 |
|
|
%
|
| 138 |
|
|
%Revision 1.5 2007/06/06 00:32:07 dashley
|
| 139 |
|
|
%Edits.
|
| 140 |
|
|
%
|
| 141 |
|
|
%Revision 1.4 2007/06/05 15:47:12 dashley
|
| 142 |
|
|
%Structural edits.
|
| 143 |
|
|
%
|
| 144 |
|
|
%Revision 1.3 2007/06/04 06:26:36 dashley
|
| 145 |
|
|
%Edits.
|
| 146 |
|
|
%
|
| 147 |
|
|
%Revision 1.2 2007/06/03 04:57:47 dashley
|
| 148 |
|
|
%Checkin to be sure that changes wrapped up in weekly TAR.GZ file.
|
| 149 |
|
|
%
|
| 150 |
|
|
%Revision 1.1 2007/04/10 23:44:47 dashley
|
| 151 |
|
|
%Initial checkin.
|
| 152 |
|
|
%
|
| 153 |
|
|
%End of $RCSfile: workprfa.tex,v $.
|
Parent Directory
| 
Revision Log