Blame Manuals/Repository-fs/repository-fs-latex/Workstation/configuration.tex

2c6393
% Part   : Preparing Your Workstation
2c6393
% Chapter: Configuration
2c6393
% ------------------------------------------------------------
2c6393
% $Id: configuration.tex 6191 2010-08-02 02:36:14Z al $
2c6393
% ------------------------------------------------------------
2c6393
2c6393
This chapter describes configurations you need to set up before using
2c6393
CentOS Artwork Repository.
2c6393
2c6393
\section{Firewall}
2c6393
2c6393
The CentOS Artwork Repository lives on the following URL:
2c6393
2c6393
\begin{quote}
2c6393
https://projects.centos.org/svn/artwork/
2c6393
\end{quote}
2c6393
2c6393
To reach this location you need to have Internet access and be sure no
2c6393
rule in your firewall is denying this site. Note that the URL uses the
2c6393
SSL protocol (port 443).
2c6393
2c6393
\section{Subversion Behind Squid}
2c6393
2c6393
Sometimes it is convenient to proxy Subversion client's requests
2c6393
through a proxy-cache server like Squid. In cases like this, the Squid
2c6393
proxy server is in the middle between you and CentOS Artwork
2c6393
Repository. If you want to proxy Subversion client's requests through
2c6393
Squid proxy-cache server, you need to configure your Subversion client
2c6393
and your Squid proxy server to do so.
2c6393
2c6393
\subsection{Subversion Client Configuration}
2c6393
2c6393
Subversion client needs to be configured to send requests to your
2c6393
Squid proxy-cache server. This configuration takes place in the file
2c6393
\texttt{$\sim$/.subversion/servers}.
2c6393
2c6393
\subsection{Squid Server Configuration}
2c6393
2c6393
Squid proxy-cache server needs to be configured to accept the
2c6393
extension methods \texttt{REPORT MERGE MKACTIVITY CHECKOUT MKCOL}.
2c6393
This configuration takes place in the file
2c6393
\texttt{/etc/squid/squid.conf}, specifically in the configuration tag
2c6393
illustrated in \autoref{fig:Workstation:Configuration:Squid}.
2c6393
2c6393
\begin{figure}[!hbp]
2c6393
\hrulefill
2c6393
\begin{verbatim}
2c6393
#  TAG: extension_methods
2c6393
#       Squid only knows about standardized HTTP request methods.
2c6393
#       You can add up to 20 additional "extension" methods here.
2c6393
#
2c6393
#Default:
2c6393
# none
2c6393
extension_methods REPORT MERGE MKACTIVITY CHECKOUT MKCOL
2c6393
\end{verbatim}
2c6393
\hrulefill
2c6393
\caption{Squid configuration to proxy Subversion client's requests.%
2c6393
   \label{fig:Workstation:Configuration:Squid}}
2c6393
\end{figure}
2c6393
2c6393
\section{Working Copy}
2c6393
2c6393
A Subversion working copy is an ordinary directory tree on your local
2c6393
system, containing a collection of files (i.e.  Translations, Designs,
2c6393
Manuals, and Scripts). You can edit these files however you wish. Your
2c6393
working copy is your own private work area: Subversion will never
2c6393
incorporate other people's changes, nor make your own changes
2c6393
available to others, until you explicitly tell it to do so.  You can
2c6393
even have multiple working copies of the same project.\footnote{Even
2c6393
this is basically correct, doing so when using CentOS Artowrk
2c6393
Repository can bring some confusion when executing scripts. Presently,
2c6393
only one absolute path can be defined as absolute path for scripts'
2c6393
execution.  You can have as many working copies of CentOS Artwork
2c6393
Repository as you want but scripts will be executed from just one
2c6393
working copy absolute path. That is, the one stored under
2c6393
\texttt{/home/centos/artwork/}}.
2c6393
2c6393
Once you've made some changes to your working copy files and verified
2c6393
that they work properly, Subversion provides you with commands to
2c6393
``publish'' your changes to the other people working with you on your
2c6393
project (by writing to the repository). If other people publish their
2c6393
own changes, Subversion provides you with commands to merge those
2c6393
changes into your working directory (by reading from the repository).
2c6393
2c6393
\begin{figure}[!hbp]
2c6393
\hrulefill
2c6393
\begin{verbatim}
2c6393
svn co https://projects.centos.org/svn/artwork /home/centos/
2c6393
\end{verbatim}
2c6393
\hrulefill
2c6393
\caption{Subversion command used to download the working copy.%
2c6393
   \label{fig:Workstation:WC:Download}}
2c6393
\end{figure}
2c6393
2c6393
The subversion command illustrated in
2c6393
\autoref{fig:Workstation:WC:Download} brings a CentOS Artwork
2c6393
Repository working copy down to your workstation, specifically to your
2c6393
home directory (\texttt{/home/centos/artwork/}). This process may take
2c6393
some time.  Once the working copy is available in your workstation,
2c6393
you are ready to start exploring and improving available works.
2c6393
2c6393
Note that you need to have a username called \texttt{centos} in your
2c6393
system.  If you don't have it, you can create it using the comand
2c6393
\texttt{useradd} as superuser (\texttt{root}).
2c6393
2c6393
\subsection{Standardizing Absolute Path}
2c6393
2c6393
When using Inkscape to import raster images inside SVG files the
2c6393
absolute image path is required. If everyone stores the working copy
2c6393
on a different absolute path imported images will not be loaded in
2c6393
those location different from those they were conceived. There is no
2c6393
way to find the right absolute image path but defining a convenction
2c6393
about it. 
2c6393
2c6393
On a path string (e.g., /home/centos/artwork/trunk/) the username
2c6393
(`centos') is the variable component, so it is the component we need
2c6393
to standardize--in the sake of keeping the working copy inside user's
2c6393
/home/ structure. Thus, analysing which username to use, the CentOS
2c6393
Project is what join us all together, so the `centos' word in
2c6393
lower-case seems to be a nice choise for us to use as common username. 
2c6393
2c6393
\section{User Identification}
2c6393
2c6393
At this point you probably have made some changes inside your working
2c6393
copy and wish to publish them.  To publish your changes on CentOS
2c6393
Artwork Repository you need to have a registered account with commit
2c6393
privilege in CentOS Artwork Repository.
2c6393
2c6393
If you are new in CentOS Artwork Repository it is possible that you
2c6393
can't commit your changes. That is because new registered accounts
2c6393
haven't commit privilege set by default.  In order for your registered
2c6393
account to have commit privilege inside CentOS Artwork Repository you
2c6393
need to request it. See section
2c6393
\ref{sec:Configuration:User:Privileges}.
2c6393
2c6393
\subsection{User Account Registration}
2c6393
\label{sec:Configuration:Account}
2c6393
2c6393
To register a user account inside CentOS Artwork Repository, you need
2c6393
to go to the following URL:
2c6393
2c6393
\begin{quote}
2c6393
\url{https://projects.centos.org/trac/artwork/}
2c6393
\end{quote}
2c6393
2c6393
\subsection{User Account Privileges}
2c6393
\label{sec:Configuration:User:Privileges}
2c6393
2c6393
To have commit privileges in CentOS Artwork Repository it is needed
2c6393
that you show your interest first, preferably with something useful
2c6393
like a new or improved design, translation, manual, or script. As
2c6393
convenction, people working on CentOS Artwork Repository share ideas
2c6393
in the mailing list
2c6393
\href{mailto:centos-devel@centos.org}{centos-devel@centos.org}. If you
2c6393
are interested in joining us go there and express yourself.
2c6393
2c6393
\section{Repository Tagged Revisions}
2c6393
2c6393
The CentOS Artwork Repository is also available as tagged revisions.
2c6393
Tagged revisions are checkpoints on the CentOS Artwork Repository
2c6393
developing lifetime. They are inmutable copies of the CentOS Artwork
2c6393
Repository state through time.  Tagged revisions contain the files
2c6393
used to produce images but not images themselves.  Inside tagged
2c6393
revisions you can find scripts (\texttt{.sh}), design templates
2c6393
(\texttt{.svg}), translation files (\texttt{\.sed}), gimp projects
2c6393
(\texttt{.xcf}), and documetation files (\texttt{.tex}).
2c6393
2c6393
CentOS Artowrk Repository tagged revisions are available for
2c6393
downloading in the following location:
2c6393
2c6393
\begin{description}
2c6393
\item[URL:] https://projects.centos.org/svn/artwork/tags
2c6393
\end{description}
2c6393
2c6393
and alternatively, you can find references in the CentOS Project's
2c6393
wiki, specifically in the ArtWork page:
2c6393
2c6393
\begin{description}
2c6393
\item[URL:] http://wiki.centos.org/ArtWork
2c6393
\end{description}