| rev |
line source |
|
igor@412
|
1 \chapter{Colaborar con otros}
|
|
igor@402
|
2 \label{cha:collab}
|
|
igor@402
|
3
|
|
igor@412
|
4 Debido a su naturaleza descentralizada, Mercurial no impone política
|
|
igor@412
|
5 alguna de cómo deben trabajar los grupos de personas. Sin embargo, si
|
|
jerojasro@414
|
6 usted es nuevo al control distribuido de versiones, es bueno tener
|
|
igor@412
|
7 herramientas y ejemplos a la mano al pensar en posibles modelos de
|
|
igor@412
|
8 flujo de trabajo.
|
|
igor@412
|
9
|
|
igor@412
|
10 \section{La interfaz web de Mercurial}
|
|
igor@412
|
11
|
|
igor@412
|
12 Mercurial tiene una poderosa interfaz web que provee bastantes
|
|
igor@412
|
13 capacidades útiles.
|
|
igor@412
|
14
|
|
igor@412
|
15 Para uso interactivo, la interfaz le permite visualizar uno o varios
|
|
igor@412
|
16 repositorios. Puede ver la historia de un repositorio, examinar cada
|
|
igor@412
|
17 cambio(comentarios y diferencias), y ver los contenidos de cada
|
|
igor@412
|
18 directorio y fichero.
|
|
igor@412
|
19
|
|
igor@412
|
20 Adicionalmente la interfaz provee feeds de RSS de los cambios de los
|
|
igor@412
|
21 repositorios. Que le permite ``subscribirse''a un repositorio usando
|
|
igor@412
|
22 su herramienta de lectura de feeds favorita, y ser notificado
|
|
igor@412
|
23 automáticamente de la actividad en el repositorio tan pronto como
|
|
igor@412
|
24 sucede. Me gusta mucho más este modelo que el estar suscrito a una
|
|
igor@412
|
25 lista de correo a la cual se envían las notificaciones, dado que no
|
|
igor@412
|
26 requiere configuración adicional de parte de quien sea que está
|
|
igor@412
|
27 administrando el repositorio.
|
|
igor@412
|
28
|
|
igor@412
|
29 La interfaz web también permite clonar repositorios a los usuarios
|
|
igor@412
|
30 remotos, jalar cambios, y (cuando el servidor está configurado para
|
|
igor@412
|
31 permitirlo) publicar cambios en el mismo. El protocolo de tunneling
|
|
igor@412
|
32 de Mercurial comprime datos agresivamente, de forma que trabaja
|
|
igor@412
|
33 eficientemente incluso con conexiones de red con poco ancho de banda.
|
|
igor@412
|
34
|
|
igor@412
|
35 La forma más sencilla de iniciarse con la interfaz web es usar su
|
|
igor@412
|
36 navegador para visitar un repositorio existente, como por ejemplo el
|
|
igor@412
|
37 repositorio principal de Mercurial \url{http://www.selenic.com/repo/hg?style=gitweb}.
|
|
igor@412
|
38
|
|
igor@412
|
39 Si está interesado en proveer una interfaz web a sus propios
|
|
igor@412
|
40 repositorios, Mercurial provee dos formas de hacerlo. La primera es
|
|
igor@412
|
41 usando la orden \hgcmd{serve}, que está enfocada a servir ``de forma
|
|
igor@412
|
42 liviana'' y por intervalos cortos. Para más detalles de cómo usar
|
|
igor@412
|
43 esta orden vea la sección~\ref{sec:collab:serve} más adelante. Si
|
|
igor@412
|
44 tiene un repositorio que desea hacer permanente, Mercurial tiene
|
|
igor@412
|
45 soporte embebido del \command{ssh} para publicar cambios con seguridad
|
|
igor@412
|
46 al repositorio central, como se documenta en la
|
|
igor@412
|
47 sección~\ref{sec:collab:ssh}. Es muy usual que se publique una copia
|
|
igor@412
|
48 de sólo lectura en el repositorio que está corriendo sobre HTTP usando
|
|
igor@412
|
49 CGI, como en la sección~\ref{sec:collab:cgi}. Publicar sobre HTTP
|
|
igor@412
|
50 satisface las necesidades de la gente que no tiene permisos de
|
|
igor@412
|
51 publicación y de aquellos que quieren usar navegadores web para
|
|
igor@412
|
52 visualizar la historia del repositorio.
|
|
igor@412
|
53
|
|
igor@412
|
54 \subsection{Trabajo con muchas ramas}
|
|
igor@412
|
55
|
|
igor@412
|
56 Los proyectos de cierta talla tienden naturlamente a progresar de
|
|
igor@412
|
57 forma simultánea en varios frentes. En el caso del software, es común
|
|
igor@412
|
58 que un proyecto tenga versiones periódicas oficiales. Una versión
|
|
igor@412
|
59 puede entrar a ``modo mantenimiento'' por un tiempo después de su
|
|
igor@412
|
60 primera publicación; las versiones de mantenimiento tienden a contener
|
|
igor@412
|
61 solamente arreglos de fallos, pero no nuevas características. En
|
|
igor@412
|
62 paralelo con las versiones de mantenimiento puede haber una o muchas
|
|
igor@412
|
63 versiones futuras pueden estar en desarrollo. La gente usa normalmente
|
|
igor@412
|
64 la palabra ``rama'' para referirse a una de las direcciones
|
|
igor@412
|
65 ligeramente distintas en las cuales procede el desarrollo.
|
|
igor@412
|
66
|
|
igor@412
|
67 Mercurial está especialmente preparado para administrar un buen número
|
|
igor@412
|
68 de ramas simultáneas pero no idénticas. Cada ``dirección de
|
|
igor@412
|
69 desarrollo'' puede vivir en su propio repositorio central, y puede
|
|
igor@412
|
70 mezclar los cambios de una a otra de acuerdo con las necesidades. Dado
|
|
igor@412
|
71 que los repositorios son independientes, uno del otro, los cambios
|
|
igor@412
|
72 inestables de una rama de desarrollo nunca afectarán una rama estable
|
|
igor@412
|
73 a menos que alguien explícitamente mezcle los cambios.
|
|
igor@412
|
74
|
|
igor@412
|
75 A continuación un ejemplo de cómo podría hacerse esto en la
|
|
igor@412
|
76 práctica. Digamos que tiene una ``rama principal'' en un servidor
|
|
igor@412
|
77 central.
|
|
igor@402
|
78 \interaction{branching.init}
|
|
igor@412
|
79 Alguien lo clona, hace cambios locales, los prueba, y los publica allí
|
|
igor@412
|
80 mismo.
|
|
igor@412
|
81
|
|
igor@412
|
82 Una vez que la rama principal alcanza una estado de versión se puede
|
|
igor@412
|
83 usar la orden \hgcmd{tag} para dar un nombre permanente a la revisión.
|
|
igor@402
|
84 \interaction{branching.tag}
|
|
igor@412
|
85 Digamos que en la rama principal ocurre más desarrollo.
|
|
igor@402
|
86 \interaction{branching.main}
|
|
igor@412
|
87 Cuando se usa la etiqueta con que se identificó la versión, la gente
|
|
igor@412
|
88 puede clonar el repositorio en cualquier momento en el futuro
|
|
igor@412
|
89 empleando \hgcmd{update} para obtener una copia del directorio de
|
|
igor@412
|
90 trabajo exacta como cuando se creó la etiqueta de la revisión que se
|
|
igor@412
|
91 consignó.
|
|
igor@402
|
92 \interaction{branching.update}
|
|
igor@402
|
93
|
|
igor@412
|
94 Adicionalmente, justo después de que la rama principal se etiquete,
|
|
igor@412
|
95 alguien puede clonarla en el servidor a una nueva rama ``estable'',
|
|
igor@412
|
96 también en el servidor.
|
|
igor@402
|
97 \interaction{branching.clone}
|
|
igor@402
|
98
|
|
igor@412
|
99 Alguien que requiera hacer un cambio en la rama estable puede clonar
|
|
igor@412
|
100 \emph{ese} repositorio, hacer sus cambios, consignar y publicarlos
|
|
igor@412
|
101 posteriormente al inicial.
|
|
igor@402
|
102 \interaction{branching.stable}
|
|
igor@412
|
103 Puesto que los repositorios de Mercurial son independientes, y que
|
|
igor@412
|
104 Mercurial no mueve los cambios de un lado a otro automáticamente, las
|
|
igor@412
|
105 ramas estable y principal están \emph{aisladas} la una de la otra.
|
|
igor@412
|
106 Los cambios que haga en la rama principal no ``se filtran'' a la rama
|
|
igor@412
|
107 estable o vice versa.
|
|
igor@412
|
108
|
|
igor@412
|
109 Es usual que los arreglos de fallos de la rama estable deban hacerse
|
|
igor@412
|
110 aparecer en la rama principal también. En lugar de reescribir el
|
|
igor@412
|
111 arreglo del fallo en la rama principal, puede jalar y mezclar los
|
|
igor@412
|
112 cambios de la rama estable a la principal, Mercurial traerá tales
|
|
igor@412
|
113 arreglos por usted.
|
|
igor@402
|
114 \interaction{branching.merge}
|
|
igor@412
|
115 La rama principal contendtrá aún los cambios que no están en la
|
|
igor@412
|
116 estable y contendrá además todos los arreglos de fallos de la rama
|
|
igor@412
|
117 estable. La rama estable permanece incólume a tales cambios.
|
|
igor@402
|
118
|
|
igor@417
|
119 \subsection{Ramas de Características}
|
|
igor@417
|
120
|
|
igor@417
|
121 En proyectos grandes, una forma efectiva de administrar los cambios es
|
|
igor@417
|
122 dividir el equipo en grupos más pequeños. Cada grupo tiene una rama
|
|
igor@417
|
123 compartida, clonada de una rama ``principal'' que conforma el proyecto
|
|
igor@417
|
124 completo. Aquellos que trabajan en ramas individuales típicamente
|
|
igor@417
|
125 están aislados de los desarrollos de otras ramas.
|
|
igor@402
|
126
|
|
igor@402
|
127 \begin{figure}[ht]
|
|
igor@402
|
128 \centering
|
|
igor@402
|
129 \grafix{feature-branches}
|
|
igor@417
|
130 \caption{Ramas de Características}
|
|
igor@402
|
131 \label{fig:collab:feature-branches}
|
|
igor@402
|
132 \end{figure}
|
|
igor@402
|
133
|
|
igor@417
|
134 Cuando una rama particular alcanza un estado deseado, alguien del
|
|
igor@417
|
135 equipo de características jala y fusiona de la rama principal hacia
|
|
igor@417
|
136 la rama de características y publica posteriormente a la rama principal.
|
|
igor@417
|
137
|
|
igor@417
|
138 \subsection{El tren de publicación}
|
|
igor@417
|
139
|
|
igor@417
|
140 Algunos proyectos se organizan al estilo``tren'': Una versión se
|
|
igor@417
|
141 planifica para ser liberada cada cierto tiempo, y las características
|
|
igor@417
|
142 que estén listas cuando ha llegado el momento ``tren'', se incorporan.
|
|
igor@417
|
143
|
|
igor@417
|
144 Este modelo tiene cierta similitud a las ramas de características. La
|
|
igor@417
|
145 diferencia es que cuando una característica pierde el tren, alguien en
|
|
igor@417
|
146 el equipo de características jala y fusiona los cambios que se fueron
|
|
igor@417
|
147 en la versión liberada hacia la rama de característica, y el trabajo
|
|
igor@417
|
148 continúa sobre lo fusionado para que la característica logre estar en
|
|
igor@417
|
149 la próxima versión.
|
|
igor@417
|
150
|
|
igor@417
|
151 \subsection{El modelo del kernel linux}
|
|
igor@417
|
152
|
|
igor@417
|
153 El desarrollo del Kernel Linux tiene una estructura jerárquica
|
|
igor@417
|
154 bastante horizontal, rodeada de una nube de caos aparente. Dado que la
|
|
igor@417
|
155 mayoría de desarrolladores usan \command{git}, una herramienta distribuida
|
|
igor@417
|
156 de control de versiones con capacidades similares a Mercurial, resulta
|
|
igor@417
|
157 de utilidad describir la forma en que el trabajo fluye en tal
|
|
igor@417
|
158 ambiente; si le gustan las ideas, la aproximación se traduce bien
|
|
igor@417
|
159 entre Git y Mercurial.
|
|
igor@417
|
160
|
|
igor@417
|
161 En el centro de la comunidad está Linus Torvalds, el creador de Linux.
|
|
igor@417
|
162 Él publica un único repositorio que es considerado el árbol
|
|
igor@417
|
163 ``oficial'' actual por la comunidad completa de
|
|
igor@417
|
164 desarrolladores. Cualquiera puede clonar el árbol de Linus, pero él es
|
|
igor@417
|
165 muy selectivo acerca de los árboles de los cuales jala.
|
|
igor@417
|
166
|
|
jerojasro@419
|
167 Linus tiene varios ``lugartenientes confiables''. Como regla, él jala
|
|
igor@417
|
168 todos los cambios que ellos publican, en la mayoría de los casos sin
|
|
igor@417
|
169 siquiera revisarlos. Algunos de sus lugartenientes generalmente
|
|
igor@417
|
170 aceptan ser los ``mantenedores'', responsables de subsistemas
|
|
igor@417
|
171 específicos dentro del kernel. Si un hacker cualquiera desea hacer un
|
|
igor@417
|
172 cambio a un subsistema y busca que termine en el árbol de Linus, debe
|
|
jerojasro@419
|
173 encontrar quién es el mantenedor del subsistema y solicitarle que
|
|
igor@417
|
174 tenga en cuenta su cambio. Si el mantenedor revisa los cambios y está
|
|
igor@417
|
175 de acuerdo en tomarlos, estos pasarán al árbol de Linus de acuerdo a
|
|
igor@417
|
176 lo expuesto.
|
|
igor@417
|
177
|
|
igor@417
|
178 Cada lugarteniente tiene su forma particular de revisar, aceptar y
|
|
igor@417
|
179 publicar los cambios; y para decidir cuando hacerlos presentes a
|
|
igor@417
|
180 Linus. Adicionalmente existen varias ramas conocidas que mucha gente
|
|
igor@417
|
181 usa para propósitos distintos. Por ejemplo, pocas personas mantienen
|
|
igor@417
|
182 repositorios ``estables'' de versiones anteriores del kernel, a los
|
|
igor@417
|
183 cuales aplican arreglos de fallos críticos necesarios. Algunos
|
|
igor@417
|
184 mantenedores publican varios árboles: uno para cambios
|
|
igor@417
|
185 experimentales; uno para cambios que van a ofrecer al mantenedor
|
|
igor@417
|
186 principal; y así sucesivamente. Otros publican un solo árbol.
|
|
igor@417
|
187
|
|
igor@417
|
188 Este modelo tiene dos características notables. La primera es que son
|
|
igor@417
|
189 de ``jalar exclusivamente''. Usted debe solicitar, convencer o
|
|
igor@417
|
190 incluso rogar a otro desarrollador para que tome sus cabmios, porque
|
|
igor@417
|
191 casi no hay árboles en los cuales más de una persona pueda publicar, y
|
|
igor@417
|
192 no hay forma de publicar cambios en un árbol que otra persona controla.
|
|
igor@417
|
193
|
|
igor@417
|
194 El segundo está basado en reputación y meritocracia. Si usted es un
|
|
igor@417
|
195 desconocido, Linus probablemente ignorará sus cambios, sin siquiera
|
|
igor@417
|
196 responderle. Pero un mantenedor de un subsistema probablemente los
|
|
igor@417
|
197 revisara, y los acogerá en caso de que aprueben su criterio de
|
|
igor@417
|
198 aplicabilidad. A medida que usted ofrezca ``mejores'' cambios a un
|
|
jerojasro@419
|
199 mantenedor, habrá más posibilidad de que se confíe en su juicio y se
|
|
igor@417
|
200 acepten los cambios. Si usted es reconocido y matiene una rama
|
|
igor@417
|
201 durante bastante tiempo para algo que Linus no ha aceptado, personas
|
|
igor@417
|
202 con intereses similares pueden jalar sus cambios regularmente para
|
|
igor@417
|
203 estar al día con su trabajo.
|
|
igor@417
|
204
|
|
igor@417
|
205 La reputación y meritocracia no necesariamente es transversal entre
|
|
igor@417
|
206 ``personas'' de diferentes subsistemas. Si usted es respetado pero es
|
|
igor@417
|
207 un hacker en almacenamiento y trata de arreglar un fallo de redes,
|
|
igor@417
|
208 tal cambio puede recibir un nivel de escrutinio de un mantenedor de
|
|
igor@417
|
209 redes comparable con el que se le haría a un completo extraño.
|
|
igor@417
|
210
|
|
igor@417
|
211 Personas que vienen de proyectos con un ordenamiento distinto, sienten
|
|
igor@417
|
212 que el proceso comparativamente caótico del Kernel Linux es
|
|
igor@417
|
213 completamente lunático. Es objeto de los caprichos individuales; la
|
|
igor@417
|
214 gente desecha cambios cuando lo desean; y la fase de desarrollo es
|
|
igor@417
|
215 alucinante. A pesar de eso Linux es una pieza de software exitosa y
|
|
igor@417
|
216 bien reconocida.
|
|
igor@417
|
217
|
|
igor@417
|
218 \subsection{Solamente jalar frente a colaboración pública}
|
|
igor@417
|
219
|
|
igor@417
|
220 Una fuente perpetua de discusiones en la comunidad de código abierto
|
|
igor@417
|
221 yace en el modelo de desarrollo en el cual la gente solamente jala
|
|
igor@417
|
222 cambios de otros ``es mejor que'' uno en el cual muchas personas
|
|
igor@417
|
223 pueden publicar cambios a un repositorio compartido.
|
|
igor@417
|
224
|
|
igor@417
|
225 Tícamente los partidarios del modelo de publicar usan las herramientas
|
|
igor@417
|
226 que se apegan a este modelo. Si usted usa una herramienta
|
|
igor@417
|
227 centralizada de control de versiones como Subversion, no hay forma de
|
|
igor@417
|
228 elegir qué modelo va a usar: La herramienta le ofrece publicación
|
|
igor@417
|
229 compartida, y si desea hacer cualquier otra cosa, va a tener que
|
|
igor@417
|
230 aplicar una aproximación artificial (tal como aplicar parches a mano).
|
|
igor@417
|
231
|
|
igor@417
|
232 Una buena herramienta distribuida de control de versiones, tal como
|
|
igor@417
|
233 Mercurial soportará los dos modelos. Usted y sus colaboradores
|
|
igor@417
|
234 pueden estructurar cómo trabajarán juntos basados en sus propias
|
|
igor@417
|
235 necesidades y preferencias, sin depender de las peripecias que la
|
|
igor@417
|
236 herramienta les obligue a hacer.
|
|
igor@417
|
237
|
|
igor@417
|
238 \subsection{Cuando la colaboración encuentra la administración ramificada}
|
|
igor@417
|
239
|
|
igor@417
|
240 Una vez que usted y su equipo configurar algunos repositorios
|
|
igor@417
|
241 compartidos y comienzan a propagar cambios entre sus repositorios
|
|
igor@417
|
242 locales y compartidos, comenzará a encarar un reto relacionado, pero
|
|
igor@417
|
243 un poco distinto: Administrar las direcciones en las cuales su equipo
|
|
igor@417
|
244 puede moverse. A pesar de que está intimamente ligado acerca de cómo
|
|
igor@417
|
245 interactúa su equipo, es lo suficientemente denso para ameritar un
|
|
igor@417
|
246 tratamiento en el capítulo~\ref{chap:branch}.
|
|
igor@417
|
247
|
|
igor@417
|
248 \section{Aspectos técnicos de la colaboración}
|
|
igor@417
|
249
|
|
igor@417
|
250 Lo que resta del capítulo lo dedicamos a las cuestiones de servir
|
|
igor@417
|
251 datos a sus colaboradores.
|
|
igor@417
|
252
|
|
igor@417
|
253 \section{Compartir informalmente con \hgcmd{serve}}
|
|
igor@402
|
254 \label{sec:collab:serve}
|
|
igor@402
|
255
|
|
igor@417
|
256 La orden \hgcmd{serve} de Mercurial satisface de forma espectacular
|
|
igor@417
|
257 las necesidades de un grupo pequeño, acoplado y de corto
|
|
igor@417
|
258 tiempo. Se constituye en una demostración de cómo se siente usar los
|
|
igor@417
|
259 comandos usando la red.
|
|
igor@417
|
260
|
|
igor@417
|
261 Ejecute \hgcmd{serve} dentro de un repositorio, y en pocos segundos
|
|
igor@417
|
262 iniciará un servidor HTTP especializado; aceptará conexiones desde
|
|
igor@417
|
263 cualquier cliente y servirá datos de este repositorio mientrs lo
|
|
igor@417
|
264 mantenga funcionando. Todo el que sepa el URL del servidor que ha
|
|
igor@417
|
265 iniciado, y que puede comunicarse con su computador por la red, puede
|
|
igor@417
|
266 usar un navegador web o Mercurial para leer datos del repositorio. Un
|
|
igor@417
|
267 URL para una instancia de \hgcmd{serve} ejecutándose en un portátil
|
|
igor@417
|
268 debería lucir algo \Verb|http://my-laptop.local:8000/|.
|
|
igor@417
|
269
|
|
igor@417
|
270 La orden \hgcmd{serve} \emph{no} es un servidor web de propósito
|
|
igor@417
|
271 general. Solamente puede hacer dos cosas:
|
|
igor@402
|
272 \begin{itemize}
|
|
igor@417
|
273 \item Permitir que se pueda visualizar la historia del repositorio que
|
|
igor@417
|
274 está sirviendo desde navegadores web.
|
|
igor@417
|
275 \item Hablar el protocolo de conexión de Mercurial para que puedan hacer
|
|
igor@417
|
276 \hgcmd{clone} o \hgcmd{pull} (jalar) cambios de tal repositorio.
|
|
igor@402
|
277 \end{itemize}
|
|
igor@417
|
278 En particular, \hgcmd{serve} no permitirá que los usuarios remotos
|
|
igor@417
|
279 puedan \emph{modificar} su repositorio. Es de tipo solo lectura.
|
|
igor@417
|
280
|
|
igor@417
|
281 Si está comenzando con Mercurial, no hay nada que le impida usar
|
|
igor@417
|
282 \hgcmd{serve} para servir un repositorio en su propio computador, y
|
|
igor@417
|
283 usar posteriormente órdenes como \hgcmd{clone}, \hgcmd{incoming}, para
|
|
igor@417
|
284 comunicarse con el servidor como si el repositorio estuviera alojado
|
|
igor@417
|
285 remotamente. Lo que además puede ayudarle a adecuarse rápidamente para
|
|
igor@417
|
286 usar comandos en repositorios alojados en la red.
|
|
igor@417
|
287
|
|
igor@417
|
288 \subsection{Cuestiones adicionales para tener en cuenta}
|
|
igor@417
|
289
|
|
igor@417
|
290 Dado que permite lectura sin autenticación a todos sus clientes,
|
|
igor@417
|
291 debería usar \hgcmd{serve} exclusivamente en ambientes en los cuáles
|
|
igor@417
|
292 no tenga problema en que otros vean, o en los cuales tenga control
|
|
igor@417
|
293 completo acerca de quien puede acceder a su red y jalar cambios de su
|
|
igor@417
|
294 repositorio.
|
|
igor@417
|
295
|
|
igor@417
|
296 La orden \hgcmd{serve} no tiene conocimiento acerca de programas
|
|
igor@417
|
297 cortafuegos que puedan estar instalados en su sistema o en su red. No
|
|
igor@417
|
298 puede detectar o controlar sus cortafuegos. Si otras personas no
|
|
igor@417
|
299 pueden acceder a su instancia \hgcmd{serve}, lo siguiente que debería hacer
|
|
igor@417
|
300 (\emph{después} de asegurarse que tienen el URL correcto) es verificar
|
|
igor@417
|
301 su configuración de cortafuegos.
|
|
igor@417
|
302
|
|
igor@417
|
303 De forma predeterminada, \hgcmd{serve} escucha conexiones entrantes en
|
|
igor@417
|
304 el puerto~8000. Si otro proceso está escuchando en tal puerto, usted
|
|
igor@417
|
305 podrá especificar un puerto distinto para escuchar con la opción
|
|
igor@417
|
306 \hgopt{serve}{-p} .
|
|
igor@417
|
307
|
|
igor@417
|
308 Normalmente, cuando se inicia \hgcmd{serve}, no imprime nada, lo cual
|
|
igor@417
|
309 puede ser desconcertante. Si desea confirmar que en efecto está
|
|
igor@417
|
310 ejecutándose correctamente, y darse cuenta qué URL debería enviar a
|
|
igor@417
|
311 sus colaboradores, inícielo con la opción \hggopt{-v}.
|
|
igor@402
|
312
|
|
igor@427
|
313 \section{Uso del protocolo Secure Shell (ssh)}
|
|
igor@402
|
314 \label{sec:collab:ssh}
|
|
igor@402
|
315
|
|
igor@427
|
316 Usted puede publicar y jalar cambios en la red de forma segura usando
|
|
igor@427
|
317 el protocolo Secure Shell (\texttt{ssh}). Para usarlo satisfactoriamente,
|
|
igor@427
|
318 tendrá que hacer algo de configuración a nivel de cliente o el
|
|
igor@427
|
319 servidor.
|
|
igor@427
|
320
|
|
igor@427
|
321 Si no está familizarizado con ssh, es un protocolo de red que le permite
|
|
igor@427
|
322 comunicarse con seguridad con otro computador. Para usarlo con
|
|
igor@427
|
323 Mercurial, estará estableciendo una o más cuentas de usuario en un
|
|
igor@427
|
324 servidor de forma tal que los usuarios remotos puedan entrar y
|
|
igor@427
|
325 ejecutar órdenes.
|
|
igor@427
|
326
|
|
igor@427
|
327 (Si ssh le \emph{es} familiar, encontrará probablemente elemental una
|
|
igor@427
|
328 porción del material a continuación.)
|
|
igor@427
|
329
|
|
igor@427
|
330 \subsection{Cómo leer y escribir URLs de ssh}
|
|
igor@427
|
331
|
|
igor@427
|
332 Los URLs de ssh tienden a lucir de la siguiente forma:
|
|
igor@402
|
333 \begin{codesample2}
|
|
igor@402
|
334 ssh://bos@hg.serpentine.com:22/hg/hgbook
|
|
igor@402
|
335 \end{codesample2}
|
|
igor@402
|
336 \begin{enumerate}
|
|
igor@427
|
337 \item La parte ``\texttt{ssh://}'' indica a Mercurial que use el
|
|
igor@427
|
338 protocolo ssh.
|
|
igor@427
|
339 \item El componente ``\texttt{bos@}'' indica el nombre del usuario que
|
|
igor@427
|
340 está entrando al servidor. Puede omitirl si el usuario remoto
|
|
igor@427
|
341 coincide con el usuario local.
|
|
igor@427
|
342 \item ``\texttt{hg.serpentine.com}'' es el nombre del servidor al cual
|
|
igor@427
|
343 se desea entrar.
|
|
igor@427
|
344 \item El ``:22'' identifica el número del puerto en el servidor al cual
|
|
igor@427
|
345 se conectará. El predeterminado es el~22, así que solamente
|
|
igor@427
|
346 necesitará especificar esa porción si \emph{no} está usando el
|
|
igor@427
|
347 puerto~22.
|
|
igor@427
|
348 \item La última porción del URL es la ruta local al repositorio en el
|
|
igor@427
|
349 servidor.
|
|
igor@402
|
350 \end{enumerate}
|
|
igor@402
|
351
|
|
igor@427
|
352 El componente de la ruta del URL para ssh es una fuente de confusión,
|
|
igor@427
|
353 puesto que no hay una forma estándar para que las herramientas puedan
|
|
igor@427
|
354 interpretarlo. Algunos programas se comportan de manera distinta a
|
|
igor@427
|
355 otros cuando manipulan estas rutas. No es la situación ideal, pero
|
|
igor@427
|
356 es muy poco probable que vaya a cambiar. Por favor lea los párrafos
|
|
igor@427
|
357 siguientes cuidadosamente.
|
|
igor@427
|
358
|
|
igor@427
|
359 Mercurial trata la ruta al repositorio en el servidor como relativo al
|
|
igor@427
|
360 directorio chasa del usuario remoto. Por ejemplo, si el usuario
|
|
igor@427
|
361 \texttt{foo} en el servidor tiene el directorio casa
|
|
igor@427
|
362 \dirname{/home/foo},
|
|
igor@427
|
363 entonces un URL ssh que contenga en su ruta a \dirname{bar}
|
|
igor@427
|
364 \emph{realmente} se refiere al directorio \dirname{/home/foo/bar}.
|
|
igor@427
|
365
|
|
igor@427
|
366 Si desea especificar una ruta relativa a otro directorio de usuario,
|
|
igor@427
|
367 puede usar una ruta que comience con un caracter tildado, seguido del
|
|
igor@427
|
368 nombre del usuario(llamémosle \texttt{otrousuario}, así
|
|
igor@427
|
369 \begin{codesample2}
|
|
igor@427
|
370 ssh://server/~otrousuario/hg/repo
|
|
igor@427
|
371 \end{codesample2}
|
|
igor@427
|
372
|
|
igor@427
|
373 Y si realmente desea especifica una ruta \emph{absoluta} en el
|
|
igor@427
|
374 servidor, comience con el componente de la ruta con dos barras como
|
|
igor@427
|
375 en el siguiente ejemplo:
|
|
igor@402
|
376 \begin{codesample2}
|
|
igor@402
|
377 ssh://server//absolute/path
|
|
igor@402
|
378 \end{codesample2}
|
|
igor@402
|
379
|
|
igor@427
|
380 \subsection{Encontrar un cliente ssh para su sistema}
|
|
igor@427
|
381
|
|
igor@427
|
382 Casi todos los sistemas tipo Unix vienen con OpenSSH preinstalado. Si
|
|
igor@427
|
383 usted está usando un sistema de estos, ejecute \Verb|which ssh| para
|
|
igor@427
|
384 identificar dónde está instalada la orden \command{ssh} (usualmente
|
|
igor@427
|
385 estará en \dirname{/usr/bin}). Si por casualidad no está presente,
|
|
igor@427
|
386 vea la documentación de sus sistema para lograr instalarlo.
|
|
igor@427
|
387
|
|
igor@427
|
388 En Windows, tendrá que escoger primero un cliente adecuado para
|
|
igor@427
|
389 descargarlo. Hay dos alternativas:
|
|
igor@402
|
390 \begin{itemize}
|
|
igor@427
|
391 \item El excelente paquete PuTTY~\cite{web:putty} de Simon Tatham, que
|
|
igor@427
|
392 ofrece un suite completo de órdenes de cliente ssh.
|
|
igor@427
|
393 \item Si tiene alta tolerancia al dolor, puede usar el porte de Cygwin
|
|
igor@427
|
394 para OpenSSH.
|
|
igor@402
|
395 \end{itemize}
|
|
igor@427
|
396 En cualquier caso, tendrá que editar su fichero \hgini\ para indicarle
|
|
igor@427
|
397 a Mercurial dónde encontrar la orden real del cliente. Por ejemplo, si
|
|
igor@427
|
398 está usando PuTTY, tendrá que usar la orden \command{plink} como un
|
|
igor@427
|
399 cliente de línea de órdenes.
|
|
igor@402
|
400 \begin{codesample2}
|
|
igor@402
|
401 [ui]
|
|
igor@427
|
402 ssh = C:/ruta/a/plink.exe -ssh -i "C:/ruta/a/mi/llave/privada"
|
|
igor@402
|
403 \end{codesample2}
|
|
igor@402
|
404
|
|
igor@402
|
405 \begin{note}
|
|
igor@427
|
406 La ruta a \command{plink} no debería contener espacios o caracteres
|
|
igor@427
|
407 en blanco, o Mercurial no podrá encontrarlo correctamente (por lo
|
|
igor@427
|
408 tanto, probablemente no sería buena idea colocarlo en
|
|
igor@427
|
409 \dirname{C:\\Program Files}
|
|
igor@402
|
410 \end{note}
|
|
igor@402
|
411
|
|
igor@427
|
412 \subsection{Generar un par de llaves}
|
|
igor@427
|
413
|
|
igor@427
|
414 Para evitar la necesidad de teclera una clave de forma repetitiva cada
|
|
igor@427
|
415 vez que necesita usar el cliente, recomiendo generar un par de llaves.
|
|
igor@427
|
416 En un sistema tipo Unix, la orden \command{ssh-keygen} también se
|
|
igor@427
|
417 comportará bien. En Windows, si está usando PuTTY, la orden
|
|
igor@427
|
418 \command{puttygen} es la que necesitará.
|
|
igor@427
|
419
|
|
igor@427
|
420 Cuando genera un par de llaves, se aconseja \emph{comedidamente}
|
|
igor@427
|
421 protegerlas con una frase de clave. (La única oportunidad en la cual
|
|
igor@427
|
422 usted querría identificarse una única vez, es cuando está usando
|
|
igor@427
|
423 el protocolo ssh para tareas automatizadas en una red segura.)
|
|
igor@427
|
424
|
|
igor@427
|
425 No basta con generar un par de llaves. Se requiere adicionar una llave
|
|
igor@427
|
426 pública al conjunto de llaves autorizadas para todos los usuarios
|
|
igor@427
|
427 remotos que se vayan a autenticar. Para aquellos servidores que usen
|
|
igor@427
|
428 OpenSSH(la gran mayoría), significará añadir la llave pública a la
|
|
igor@427
|
429 lista en el fichero llamado \sfilename{authorized\_keys} en su
|
|
igor@427
|
430 directorio \sdirname{.ssh}.
|
|
igor@427
|
431
|
|
igor@427
|
432 En sistemas tipo Unix, su llave pública tendrá la extensión
|
|
igor@427
|
433 \filename{.pub}. Si usa \command{puttygen} en Windows, puede
|
|
igor@427
|
434 guardar la llave pública en un fichero de su elección, o pegarla desde
|
|
igor@427
|
435 la ventana en la cual se despliega directamente en el fichero
|
|
igor@427
|
436 \sfilename{authorized\_keys}.
|
|
igor@402
|
437
|
|
igor@428
|
438 \subsection{Uso de un agente de autenticación}
|
|
igor@428
|
439
|
|
igor@428
|
440 Un agente de autentitcación es un daemonio que almacena frases clave en
|
|
igor@428
|
441 memoria(olvidará las frases clave si sale y vuelve a entrar). Un cliente
|
|
igor@428
|
442 ssh notará si está corriendo, y solicitará una frase clave. Si no hay
|
|
igor@428
|
443 un agente de autenticación corriendo, o el agente no almacena la frase
|
|
igor@428
|
444 clave necesaria, tendrá que teclear su frase clave cada vez que
|
|
igor@428
|
445 Mercurial intente comunicarse con un servidor para usted(p.e.~cada vez
|
|
igor@428
|
446 que jale o publique cambios).
|
|
igor@428
|
447
|
|
igor@428
|
448 El problema de almacenar frases claves en un agente es que es posible
|
|
igor@428
|
449 para un atacante bien preparado recuperar el texto plano de su frase
|
|
igor@428
|
450 clave, en alguntos casos incluso si su sistema sea muy alternante.
|
|
igor@428
|
451 Es su decisión si es un riesgo aceptable. Lo que si es seguro es que
|
|
igor@428
|
452 evita reteclear.
|
|
igor@428
|
453
|
|
igor@428
|
454 En sistemas tipo Unix, el agente se llama \command{ssh-agent}, y
|
|
igor@428
|
455 usualmente se ejecuta automáticamente cuando usted entra. Tendrá que
|
|
igor@428
|
456 usar la orden \command{ssh-add} para añadir frases claves al agente. En
|
|
igor@428
|
457 Windows, si está usando PuTTY, la orden \command{pageant} actúa como
|
|
igor@428
|
458 el agente. Añade un ícono a su barra del sistema que le permitirá
|
|
igor@428
|
459 almacenar frases clave.
|
|
igor@428
|
460
|
|
igor@428
|
461 \subsection{Configurar el lado del servidor apropiadamente}
|
|
igor@428
|
462
|
|
igor@428
|
463 Dado que puede ser dispendioso configurar ssh si usted es nuevo, hay
|
|
igor@428
|
464 una variedad de cosas que podrían ir mal. Añada piense primero en
|
|
igor@428
|
465 Mercurial y hay mucho más en qué pensar. La mayor parte de estos
|
|
igor@428
|
466 problemas potenciales occuren en el lado del servidor, no en el cliente.
|
|
igor@428
|
467 Las buenas noticias es que una vez tiene una configuración funcional,
|
|
igor@428
|
468 usualmente continuará trabajando indefinidamente.
|
|
igor@428
|
469
|
|
igor@428
|
470 Antes de intentar que Mercurial hable con un servidor ssh, es mejor
|
|
igor@428
|
471 asegurarse que puede usar la orden normal \command{ssh} o \command{putty}
|
|
igor@428
|
472 para comunicarse con el servidor primero. Si tiene problemas usando
|
|
igor@428
|
473 estas órdenes directamente, de seguro Mercurial no funcionará. Pero aún,
|
|
igor@428
|
474 esconderá el problema subyacente. Cuando desee revisar un problema
|
|
igor@428
|
475 relacionado con ssh y Mercurial, debería asegurarse primero que las
|
|
igor@428
|
476 órdenes de ssh en el lado del cliente funcionan primero, \emph{antes}
|
|
igor@428
|
477 de preocuparse por si existe un problema con Mercurial.
|
|
igor@428
|
478
|
|
igor@428
|
479 Lo primero para asegurar en el lado del servidor es que puede entrar
|
|
igor@428
|
480 desde otra máquina. Si no puede entrar con \command{ssh} o
|
|
igor@428
|
481 \command{putty}, el mensaje de error que obtenga le puede dar pistas
|
|
igor@428
|
482 de qué ha ido mal. Los problemas más comunes son los siguientes:
|
|
igor@402
|
483 \begin{itemize}
|
|
igor@428
|
484 \item Si obitene un error de ``conexión rehusada'', es posible que no
|
|
igor@428
|
485 haya un daemonio SSH corriendo en el servidor o que no pueda accederse
|
|
igor@428
|
486 a él por configuraciones de cortafuegos.
|
|
igor@428
|
487 \item Si obtiene un error de ``no hay ruta hasta el servidor'', puede
|
|
igor@428
|
488 tener la dirección del servidor incorrecta o un cortafuegos con
|
|
igor@428
|
489 bloqueo agresivo que no permitirá su existencia.
|
|
igor@428
|
490 \item Si obtiene un mensaje de ``permiso denegado'', puede que haya
|
|
igor@428
|
491 tecleado mal el usuario en el servidor, o que haya tecleado
|
|
igor@428
|
492 incorrectamente la frase clave o la clave del usuario remoto.
|
|
igor@402
|
493 \end{itemize}
|
|
igor@428
|
494 En resumen, si tiene problemas al comunicarse con el daemonio ssh del
|
|
igor@428
|
495 servidor, primero asegúrese de que está corriendo. En muchos sistemas
|
|
igor@428
|
496 estará instalado, pero deshabilitado de forma predeterminada. Una vez
|
|
igor@428
|
497 que haya hecho este paso tendrá que revisar si el cortafuegos del
|
|
igor@428
|
498 servidor está configurado para recibir conexiones entrantes en el
|
|
igor@428
|
499 puerto en el cual el daemonio de ssh está escuchando(usualmente el~22).
|
|
igor@428
|
500 No trate de buscar otras posibilidades exóticas o configuraciones
|
|
igor@428
|
501 erradas haste que haya revisado primero estas dos.
|
|
igor@428
|
502
|
|
igor@428
|
503 Si está usando un agente de autenticación en el lado del cliente para
|
|
igor@428
|
504 almacenar las frase claves de sus contraseñas, debería poder entrar al
|
|
igor@428
|
505 servidor sin necesidad de que se le solicite frases claves o
|
|
igor@428
|
506 contraseñas. Si se le pregunta alguna, a continuación algunas
|
|
igor@428
|
507 posibilidades:
|
|
igor@402
|
508 \begin{itemize}
|
|
igor@428
|
509 \item Puede haber olvidado usar \command{ssh-add} o
|
|
igor@428
|
510 \command{pageant} para guardar la frase clave.
|
|
igor@428
|
511 \item Puede haber almacenado una frase clave errónea para la llave.
|
|
igor@402
|
512 \end{itemize}
|
|
igor@428
|
513 Si se le solicita la clave del usuario remoto, hay otras posibilidades
|
|
igor@428
|
514 que deben revisarse:
|
|
igor@402
|
515 \begin{itemize}
|
|
igor@428
|
516 \item O bien el directorio del usuario o su directorio \sdirname{.ssh}
|
|
igor@428
|
517 tiene permisos excesivamente abiertos. Como resultado el daemonio
|
|
igor@428
|
518 ssh no creerá o leerá su fichero \sfilename{authorized\_keys}.
|
|
igor@428
|
519 Por ejemplo, un directorio casa o \sdirname{.ssh} causará aveces
|
|
igor@428
|
520 este síntoma.
|
|
igor@428
|
521 \item El fichero de usuario \sfilename{authorized\_keys} puede tener
|
|
igor@428
|
522 un problema. Si alguien distinto al usuario es dueño o puede
|
|
igor@428
|
523 escribir el archivo, el daemonio ssh no confiará o lo leerá.
|
|
igor@402
|
524 \end{itemize}
|
|
igor@402
|
525
|
|
igor@428
|
526 En un mundo ideal, debería poder ejecutar la siguiente orden
|
|
igor@428
|
527 exitósamente, y debería imprimir exactamente una línea de salida,
|
|
igor@428
|
528 la fecha y hora actual.
|
|
igor@428
|
529 \begin{codesample2}
|
|
igor@428
|
530 ssh miservidor fecha
|
|
igor@428
|
531 \end{codesample2}
|
|
igor@428
|
532
|
|
igor@428
|
533 Si en su servidor tiene guión que se ejecuta a la entrada e imprimie
|
|
igor@428
|
534 letreros o cualquier otra cosa, incluso cuando se ejecutan órdenes no
|
|
igor@428
|
535 interactivas como esta, debería arreglarlo antes de continuar, de
|
|
igor@428
|
536 forma que solamente imprima algo si se ejecuta interactivamente. De
|
|
igor@428
|
537 otra forma estos letreros al menos llenarán la salida de Mercurial.
|
|
igor@428
|
538 incluso podrían causar problemas potenciales cuando se ejecuten
|
|
igor@428
|
539 órdenes de forma remota. Mercurial intenta detectar e ignorar los
|
|
igor@428
|
540 letreros en sesiones no interactivas de \command{ssh}, pero no es
|
|
igor@428
|
541 a prueba de tontos. (Si edita sus guiones de entrada en el servidor,
|
|
igor@428
|
542 la forma usual de ver si un guión de script se ejecuta en un shell
|
|
igor@428
|
543 interactivo, es verificar el código de retorno de la orden
|
|
igor@428
|
544 \Verb|tty -s|.)
|
|
igor@428
|
545
|
|
igor@428
|
546 Cuando verifique que el venerado ssh funciona en su servidor, el
|
|
igor@428
|
547 paso siguiente es asegurar que Mercurial corre en el servidor. La
|
|
igor@428
|
548 orden siguiente debería ejecutarse satisfactoriamente:
|
|
igor@428
|
549 \begin{codesample2}
|
|
igor@428
|
550 ssh miservidor hg version
|
|
igor@428
|
551 \end{codesample2}
|
|
igor@428
|
552 Si ve un mensaje de error en lugar de la salida usual de
|
|
igor@428
|
553 \hgcmd{version}, será porque no ha instalado Mercurial en
|
|
igor@428
|
554 \dirname{/usr/bin}. No se preocupe si este es el caso; no necesita
|
|
igor@428
|
555 hacerlo. Pero debería revisar los posibles problemas presentados a
|
|
igor@428
|
556 continuación:
|
|
igor@402
|
557 \begin{itemize}
|
|
igor@428
|
558 \item Está instalado Mercurial en el servidor? Se que suena trivial
|
|
igor@428
|
559 pero es mejor revisar!
|
|
igor@428
|
560 \item Tal vez la ruta de búsqueda de la interfaz de órdenes
|
|
igor@428
|
561 (normalmente vía la variable de ambiente \envar{PATH}) simplemente
|
|
igor@428
|
562 está mal configurada.
|
|
igor@428
|
563 \item Puede ser que su variable de ambiente \envar{PATH} soalamente
|
|
igor@428
|
564 apunte al lugar en el cual está el ejecutable \command{hg} si la
|
|
igor@428
|
565 sesión de entrada es interactiva. Puede suceder si establece la
|
|
igor@428
|
566 ruta en el guión de shell de entrada incorrecto. Consulte la
|
|
igor@428
|
567 documentación de su línea de órdenes.
|
|
igor@428
|
568 \item La variable de ambiente \envar{PYTHONPATH} puede requerir la
|
|
igor@428
|
569 ruta a los módulos de Mercurial en Python. Puede que nisiquiera
|
|
igor@428
|
570 está establecida; podría estar incorrecta; o puede ser que se
|
|
igor@428
|
571 establezca únicamente cuando hay entradas interactivas.
|
|
igor@402
|
572 \end{itemize}
|
|
igor@402
|
573
|
|
igor@428
|
574 Si puede ejecutar \hgcmd{version} sobre una conexión ssh,
|
|
igor@428
|
575 felicitaciones! Ha logrado la interacción entre el cliente y el
|
|
igor@428
|
576 servidor. Ahora debería poder acceder a los repositorios de
|
|
igor@428
|
577 Mercurial que tiene el usuario en el servidor. Si tiene problemas
|
|
igor@428
|
578 con Mercurial y ssh en este punto, intente usar la opción
|
|
igor@428
|
579 \hggopt{--debug} para tener información más clara de lo que está
|
|
igor@428
|
580 sucediendo.
|
|
igor@428
|
581
|
|
igor@428
|
582 \subsection{Compresión con ssh}
|
|
igor@428
|
583
|
|
igor@428
|
584 Mercurial no comprime datos cuando usa el protocolo ssh, dado que
|
|
igor@428
|
585 el protocolo puede comprimir datos transparentemente. Pero el
|
|
igor@428
|
586 comportamiento predeterminado del cliente ssh es \emph{no}
|
|
igor@428
|
587 solicitar compresión.
|
|
igor@428
|
588
|
|
igor@428
|
589 Sobre cualquier red distinta a una LAN rápida(incluso con una red
|
|
igor@428
|
590 inalámbrica), hacer uso de compresión puede mejorar el rendimiento
|
|
igor@428
|
591 de las operaciones de Mercurial que involucren la red. Por ejemplo,
|
|
igor@428
|
592 sobre WAN, alguien ha medido la compresión reduciendo la cantidad
|
|
igor@428
|
593 de tiempo requerido para clonar un repositorio particularmente
|
|
igor@428
|
594 grande de~51 minutos a~17 minutos.
|
|
igor@428
|
595
|
|
igor@428
|
596 Tanto \command{ssh} como \command{plink} aceptan la opción
|
|
igor@428
|
597 \cmdopt{ssh}{-C} que activa la compresión. Puede editar fácilmente
|
|
igor@428
|
598 su \hgrc\ para habilitar la compresión para todos los usos de
|
|
igor@428
|
599 Mercurial sobre el protocolo ssh.
|
|
igor@402
|
600 \begin{codesample2}
|
|
igor@402
|
601 [ui]
|
|
igor@402
|
602 ssh = ssh -C
|
|
igor@402
|
603 \end{codesample2}
|
|
igor@402
|
604
|
|
igor@428
|
605 Si usa \command{ssh}, puede reconfigurarlo para que siempre use
|
|
igor@428
|
606 compresión cuando se comunique con su servidor. Para hacerlo,
|
|
igor@428
|
607 edite su fichero \sfilename{.ssh/config}(que puede no existir
|
|
igor@428
|
608 aún), de la siguiente forma:
|
|
igor@402
|
609 \begin{codesample2}
|
|
igor@402
|
610 Host hg
|
|
igor@402
|
611 Compression yes
|
|
igor@428
|
612 HostName hg.ejemplo.com
|
|
igor@428
|
613 \end{codesample2}
|
|
igor@428
|
614 Que define un alias, \texttt{hg}. Cuando lo usa con la orden
|
|
igor@428
|
615 \command{ssh} o con una URL de Mercurial con protocolo\texttt{ssh},
|
|
igor@428
|
616 logrará que \command{ssh} se conecte a \texttt{hg.ejemplo.com}
|
|
igor@428
|
617 con compresión. Que le dará un nombre más corto para teclear y
|
|
igor@428
|
618 compresión, los cuales por derecho propio son buenos.
|
|
igor@402
|
619
|
|
igor@429
|
620 \section{Uso de CGI a través de HTTP}
|
|
igor@402
|
621 \label{sec:collab:cgi}
|
|
igor@402
|
622
|
|
igor@429
|
623 Dependiendo de qué tan ambicioso sea, configurar la interfaz CGI
|
|
igor@429
|
624 de Mercurial puede tomar desde unos minutos hasta varias horas.
|
|
igor@429
|
625
|
|
igor@429
|
626 Comenzaremos con el ejemplo más sencillo, y nos dirigiremos hacia
|
|
igor@429
|
627 configuraciones más complejas. Incluso para el caso más básico
|
|
igor@429
|
628 necesitará leer y modificar su configuración del servidor web.
|
|
igor@402
|
629
|
|
igor@402
|
630 \begin{note}
|
|
igor@429
|
631 Configurar un servidor web es una actividad compleja, engorrosa y
|
|
igor@429
|
632 altamente dependiente del sistema. De ninguna manera podremos
|
|
igor@429
|
633 cubrir todos los casos posibles con los cuales pueda encontrarse.
|
|
igor@429
|
634 Use su discresión y juicio respecto a las secciones siguientes.
|
|
igor@429
|
635 Esté preparado para cometer muchas equivocaciones, y emplear
|
|
igor@429
|
636 bastante tiempo leyendo sus bitácoras de error del servidor.
|
|
igor@402
|
637 \end{note}
|
|
igor@402
|
638
|
|
igor@429
|
639 \subsection{Lista de chequeo de la configuración del servidor web}
|
|
igor@429
|
640
|
|
igor@429
|
641 Antes de continuar, tómese un tiempo para revisar ciertos aspectos de
|
|
igor@429
|
642 la configuración de su sistema:
|
|
igor@402
|
643
|
|
igor@402
|
644 \begin{enumerate}
|
|
igor@429
|
645 \item ¿Tiene un servidor web? Mac OS X viene con Apache, pero otros
|
|
igor@429
|
646 sistemas pueden no tener un servidor web instalado.
|
|
igor@429
|
647 \item Si tiene un servidor web instalado, ¿Está ejecutándose? En la
|
|
igor@429
|
648 mayoría de sistemas, aunque esté presente, puede no estar habilitado
|
|
igor@429
|
649 de forma predeterminada.
|
|
igor@429
|
650 \item ¿u servidor está configurado para permitir ejecutar programas
|
|
igor@429
|
651 CGI en el directorio donde planea hacerlo? Casi todos los
|
|
igor@429
|
652 servidores de forma predeterminada explícitamente inhiben la
|
|
igor@429
|
653 habilidad de ejecutar programas CGI.
|
|
igor@402
|
654 \end{enumerate}
|
|
igor@402
|
655
|
|
igor@429
|
656 Si no tiene un servidor web instalado, y no tiene cierta experiencia
|
|
igor@429
|
657 configurando Apache, debería considerar usar el servidor web
|
|
igor@429
|
658 \texttt{lighttpd} en lugar de Apache. Apache tiene una reputación
|
|
igor@429
|
659 bien ganada por su configuración barroca y confusa.
|
|
igor@429
|
660 A pesar de que \texttt{lighttpd} tiene menos características que
|
|
igor@429
|
661 Apache en ciertas áreas, las mismas no son relevantes para servir
|
|
igor@429
|
662 repositorios de Mercurial. Definitivamente es mucho más sencillo
|
|
igor@429
|
663 comenzar con \texttt{lighttpd} que con Apache.
|
|
igor@429
|
664
|
|
igor@429
|
665 \subsection{Configuración básica de CGI}
|
|
igor@429
|
666
|
|
igor@429
|
667 En sistemas tipo Unix es común que los usuarios tengan un subdirectorio
|
|
igor@429
|
668 con un nombre como \dirname{public\_html} en su directorio personal,
|
|
igor@429
|
669 desde el cual pueden servir páginas web. Un fichero llamado \filename{foo}
|
|
igor@429
|
670 en este directorio será visible en una URL de la forma
|
|
igor@402
|
671 \texttt{http://www.example.com/\~username/foo}.
|
|
igor@402
|
672
|
|
igor@429
|
673 Para comenzar, encuentre el guión \sfilename{hgweb.cgi} que debería
|
|
igor@429
|
674 estar presente en su instalación de Mercurial. Si no puede
|
|
igor@429
|
675 encontrarlo rápidamente una copia local en su sistema, puede
|
|
igor@429
|
676 descargarlo del repositorio principal de Mercurial en
|
|
igor@402
|
677 \url{http://www.selenic.com/repo/hg/raw-file/tip/hgweb.cgi}.
|
|
igor@402
|
678
|
|
igor@429
|
679 Tendrá que copiar este guión en su directorio \dirname{public\_html},
|
|
igor@429
|
680 y asegurarse que sea ejecutable.
|
|
igor@402
|
681 \begin{codesample2}
|
|
igor@402
|
682 cp .../hgweb.cgi ~/public_html
|
|
igor@402
|
683 chmod 755 ~/public_html/hgweb.cgi
|
|
igor@402
|
684 \end{codesample2}
|
|
igor@429
|
685 El argumento \texttt{755} de la orden \command{chmod} es un poco más
|
|
igor@429
|
686 general que hacerlo ejecutable: Asegura que el guión sea ejecutable
|
|
igor@429
|
687 por cualquiera, y que el ``grupo'' y los ``otros'' \emph{not} tengan
|
|
igor@429
|
688 permiso de escritura. Si dejara los permisos de escritura abiertos,
|
|
igor@429
|
689 , el subsistema \texttt{suexec} de Apache probablemente se negaría
|
|
igor@429
|
690 a ejecutar el guión. De hecho, \texttt{suexec} también insiste en que
|
|
igor@429
|
691 el \emph{directorio} en el cual reside el guión no tenga permiso de
|
|
igor@429
|
692 escritura para otros.
|
|
igor@402
|
693 \begin{codesample2}
|
|
igor@402
|
694 chmod 755 ~/public_html
|
|
igor@402
|
695 \end{codesample2}
|
|
igor@402
|
696
|
|
igor@436
|
697 \subsubsection{¿Qué \emph{podría} resultar mal?}
|
|
igor@402
|
698 \label{sec:collab:wtf}
|
|
igor@402
|
699
|
|
igor@436
|
700 Cuando haya ubicado el CGI en el sitio correspondiente con un navegador
|
|
igor@436
|
701 intente visitar el URL \url{http://myhostname/~myuser/hgweb.cgi},
|
|
igor@436
|
702 \emph{sin} dejarse abatir por un error. Hay una alta probabilidad de
|
|
igor@436
|
703 que esta primera visita al URL sea fallida, y hay muchas razones posibles
|
|
igor@436
|
704 para este comportamiento. De hecho, podría toparse con cada uno de los
|
|
igor@436
|
705 errores que describimos a continuación, así que no deje de leerlos
|
|
igor@436
|
706 cuidadosamente. A continuación presento los problemas que yo tuve en
|
|
igor@436
|
707 un sistema con Fedora~7, con una instalación nueva de Apache, y una
|
|
igor@436
|
708 cuenta de usuario que creé específicamente para desarrollar este
|
|
igor@436
|
709 ejercicio.
|
|
igor@436
|
710
|
|
igor@436
|
711 Su servidor web puede tener directorios por usuario deshabilitados. Si
|
|
igor@436
|
712 usa Apache, busque el fichero de configuración que contenga la
|
|
igor@436
|
713 directiva \texttt{UserDir}. Si no está presente en sitio alguno, los
|
|
igor@436
|
714 directorios por usuario están deshabilitados. Si la hay, pero su
|
|
igor@436
|
715 valor es \texttt{disabled}, los directorios por usuario estarán
|
|
igor@436
|
716 deshabilitados. La directiva \texttt{UserDir} en caso contrario tendrá
|
|
igor@436
|
717 el nombre del subdirectorio bajo el cual Apache mirará en el
|
|
igor@436
|
718 directorio de cada usuario, por ejemplo \dirname{public\_html}.
|
|
igor@436
|
719
|
|
igor@436
|
720 Los permisos de sus ficheros pueden ser demasiado restrictivos. El
|
|
igor@436
|
721 servidor web debe poder recorrer su directorio personal y los
|
|
igor@436
|
722 directorios que estén bajo \dirname{public\_html}, además de tener
|
|
igor@436
|
723 permiso para leer aquellos que estén adentro. A continúación una
|
|
igor@436
|
724 receta rápida para hacer que sus permisos estén acordes con las
|
|
igor@436
|
725 necesidades básicas.
|
|
igor@402
|
726 \begin{codesample2}
|
|
igor@402
|
727 chmod 755 ~
|
|
igor@402
|
728 find ~/public_html -type d -print0 | xargs -0r chmod 755
|
|
igor@402
|
729 find ~/public_html -type f -print0 | xargs -0r chmod 644
|
|
igor@402
|
730 \end{codesample2}
|
|
igor@402
|
731
|
|
igor@436
|
732 Otra posibilidad con los permisos es que obtenga una ventana
|
|
igor@436
|
733 completamente en blanco cuando trata de cargar el script. En cuyo
|
|
igor@436
|
734 caso, es posible que los permisos que tiene son \emph{demasiado
|
|
igor@436
|
735 permisivos}. El subsistema \texttt{suexec} de Apache no ejecutará un
|
|
igor@436
|
736 script que tenga permisos de escritura para el group o el planeta, por
|
|
igor@436
|
737 ejemplo.
|
|
igor@436
|
738
|
|
igor@436
|
739 Su servidor web puede estar configurado para evitar la ejecución de
|
|
igor@436
|
740 programas CGI en los directorios de usuario. A continuación presento
|
|
igor@436
|
741 una configuración predeterminada por usuario en mi sistema Fedora.
|
|
igor@436
|
742
|
|
igor@402
|
743 \begin{codesample2}
|
|
igor@402
|
744 <Directory /home/*/public_html>
|
|
igor@402
|
745 AllowOverride FileInfo AuthConfig Limit
|
|
igor@402
|
746 Options MultiViews Indexes SymLinksIfOwnerMatch IncludesNoExec
|
|
igor@402
|
747 <Limit GET POST OPTIONS>
|
|
igor@402
|
748 Order allow,deny
|
|
igor@402
|
749 Allow from all
|
|
igor@402
|
750 </Limit>
|
|
igor@402
|
751 <LimitExcept GET POST OPTIONS>
|
|
igor@402
|
752 Order deny,allow
|
|
igor@402
|
753 Deny from all
|
|
igor@402
|
754 </LimitExcept>
|
|
igor@402
|
755 </Directory>
|
|
igor@402
|
756 \end{codesample2}
|
|
igor@436
|
757 Si encuentra un grupo de instrucciones de \texttt{Directory} similares
|
|
igor@436
|
758 en su configuración de Apache, la directiva a revisar es \texttt{Options}.
|
|
igor@436
|
759 Adicione \texttt{ExecCGI} al final de esta lista en caso de que haga
|
|
igor@436
|
760 falta y reinicie su servidor web.
|
|
igor@436
|
761
|
|
igor@436
|
762 Si resulta que Apache le muestra el texto del script CGI en lugar de
|
|
igor@436
|
763 ejecutarlo, necesitará o bien descomentar(si se encuentra presente) o
|
|
igor@436
|
764 adicionar una directiva como la siguiente:
|
|
igor@402
|
765 \begin{codesample2}
|
|
igor@402
|
766 AddHandler cgi-script .cgi
|
|
igor@402
|
767 \end{codesample2}
|
|
igor@402
|
768
|
|
igor@436
|
769 Otra posibilidad es que observe una traza de Python en colores
|
|
igor@436
|
770 informando que no puede importar un módulo relacionado con
|
|
igor@436
|
771 \texttt{mercurial}. Esto es un gran progreso! El servidor es capaz
|
|
igor@436
|
772 de ejecutar su script CGI. Este error solamente ocurrirá si está
|
|
igor@436
|
773 ejecutando una instalación privada de Mercurial en lugar de una
|
|
igor@436
|
774 instalación para todo el sistema. Recuerde que el servidor que
|
|
igor@436
|
775 ejecuta el programa CGI no cuenta con variables de ambiente de las
|
|
igor@436
|
776 cuales usted si dispone en una sesión interactiva. Si este error le
|
|
igor@436
|
777 ocurre, edite su copia de \sfilename{hgweb.cgi} y siga las indicaciones
|
|
igor@436
|
778 dentro del mismo para establecer de forma adecuada su variable de
|
|
igor@436
|
779 ambiente \envar{PYTHONPATH}.
|
|
igor@436
|
780
|
|
igor@436
|
781 Finalmente, si encuentra \emph{otra} traza a todo color de Python al visitar
|
|
igor@436
|
782 el URL: Esta seguramente se referirá a que no puede encontrar
|
|
igor@436
|
783 \dirname{/path/to/repository}. Edite su script \sfilename{hgweb.cgi}
|
|
igor@436
|
784 y reemplaze la cadena \dirname{/path/to/repository} con la ruta
|
|
igor@436
|
785 completa al repositorio que desea servir.
|
|
igor@436
|
786
|
|
igor@436
|
787 En este punto, cuando trate de recargar la página, deberá visualizar
|
|
igor@436
|
788 una linda vista HTML de la historia de su repositorio. Uff!
|
|
igor@402
|
789
|
|
igor@402
|
790 \subsubsection{Configuring lighttpd}
|
|
igor@402
|
791
|
|
igor@402
|
792 To be exhaustive in my experiments, I tried configuring the
|
|
igor@402
|
793 increasingly popular \texttt{lighttpd} web server to serve the same
|
|
igor@402
|
794 repository as I described with Apache above. I had already overcome
|
|
igor@402
|
795 all of the problems I outlined with Apache, many of which are not
|
|
igor@402
|
796 server-specific. As a result, I was fairly sure that my file and
|
|
igor@402
|
797 directory permissions were good, and that my \sfilename{hgweb.cgi}
|
|
igor@402
|
798 script was properly edited.
|
|
igor@402
|
799
|
|
igor@402
|
800 Once I had Apache running, getting \texttt{lighttpd} to serve the
|
|
igor@402
|
801 repository was a snap (in other words, even if you're trying to use
|
|
igor@402
|
802 \texttt{lighttpd}, you should read the Apache section). I first had
|
|
igor@402
|
803 to edit the \texttt{mod\_access} section of its config file to enable
|
|
igor@402
|
804 \texttt{mod\_cgi} and \texttt{mod\_userdir}, both of which were
|
|
igor@402
|
805 disabled by default on my system. I then added a few lines to the end
|
|
igor@402
|
806 of the config file, to configure these modules.
|
|
igor@402
|
807 \begin{codesample2}
|
|
igor@402
|
808 userdir.path = "public_html"
|
|
igor@402
|
809 cgi.assign = ( ".cgi" => "" )
|
|
igor@402
|
810 \end{codesample2}
|
|
igor@402
|
811 With this done, \texttt{lighttpd} ran immediately for me. If I had
|
|
igor@402
|
812 configured \texttt{lighttpd} before Apache, I'd almost certainly have
|
|
igor@402
|
813 run into many of the same system-level configuration problems as I did
|
|
igor@402
|
814 with Apache. However, I found \texttt{lighttpd} to be noticeably
|
|
igor@402
|
815 easier to configure than Apache, even though I've used Apache for over
|
|
igor@402
|
816 a decade, and this was my first exposure to \texttt{lighttpd}.
|
|
igor@402
|
817
|
|
igor@402
|
818 \subsection{Sharing multiple repositories with one CGI script}
|
|
igor@402
|
819
|
|
igor@402
|
820 The \sfilename{hgweb.cgi} script only lets you publish a single
|
|
igor@402
|
821 repository, which is an annoying restriction. If you want to publish
|
|
igor@402
|
822 more than one without wracking yourself with multiple copies of the
|
|
igor@402
|
823 same script, each with different names, a better choice is to use the
|
|
igor@402
|
824 \sfilename{hgwebdir.cgi} script.
|
|
igor@402
|
825
|
|
igor@402
|
826 The procedure to configure \sfilename{hgwebdir.cgi} is only a little
|
|
igor@402
|
827 more involved than for \sfilename{hgweb.cgi}. First, you must obtain
|
|
igor@402
|
828 a copy of the script. If you don't have one handy, you can download a
|
|
igor@402
|
829 copy from the master Mercurial repository at
|
|
igor@402
|
830 \url{http://www.selenic.com/repo/hg/raw-file/tip/hgwebdir.cgi}.
|
|
igor@402
|
831
|
|
igor@402
|
832 You'll need to copy this script into your \dirname{public\_html}
|
|
igor@402
|
833 directory, and ensure that it's executable.
|
|
igor@402
|
834 \begin{codesample2}
|
|
igor@402
|
835 cp .../hgwebdir.cgi ~/public_html
|
|
igor@402
|
836 chmod 755 ~/public_html ~/public_html/hgwebdir.cgi
|
|
igor@402
|
837 \end{codesample2}
|
|
igor@402
|
838 With basic configuration out of the way, try to visit
|
|
igor@402
|
839 \url{http://myhostname/~myuser/hgwebdir.cgi} in your browser. It
|
|
igor@402
|
840 should display an empty list of repositories. If you get a blank
|
|
igor@402
|
841 window or error message, try walking through the list of potential
|
|
igor@402
|
842 problems in section~\ref{sec:collab:wtf}.
|
|
igor@402
|
843
|
|
igor@402
|
844 The \sfilename{hgwebdir.cgi} script relies on an external
|
|
igor@402
|
845 configuration file. By default, it searches for a file named
|
|
igor@402
|
846 \sfilename{hgweb.config} in the same directory as itself. You'll need
|
|
igor@402
|
847 to create this file, and make it world-readable. The format of the
|
|
igor@402
|
848 file is similar to a Windows ``ini'' file, as understood by Python's
|
|
igor@402
|
849 \texttt{ConfigParser}~\cite{web:configparser} module.
|
|
igor@402
|
850
|
|
igor@402
|
851 The easiest way to configure \sfilename{hgwebdir.cgi} is with a
|
|
igor@402
|
852 section named \texttt{collections}. This will automatically publish
|
|
igor@402
|
853 \emph{every} repository under the directories you name. The section
|
|
igor@402
|
854 should look like this:
|
|
igor@402
|
855 \begin{codesample2}
|
|
igor@402
|
856 [collections]
|
|
igor@402
|
857 /my/root = /my/root
|
|
igor@402
|
858 \end{codesample2}
|
|
igor@402
|
859 Mercurial interprets this by looking at the directory name on the
|
|
igor@402
|
860 \emph{right} hand side of the ``\texttt{=}'' sign; finding
|
|
igor@402
|
861 repositories in that directory hierarchy; and using the text on the
|
|
igor@402
|
862 \emph{left} to strip off matching text from the names it will actually
|
|
igor@402
|
863 list in the web interface. The remaining component of a path after
|
|
igor@402
|
864 this stripping has occurred is called a ``virtual path''.
|
|
igor@402
|
865
|
|
igor@402
|
866 Given the example above, if we have a repository whose local path is
|
|
igor@402
|
867 \dirname{/my/root/this/repo}, the CGI script will strip the leading
|
|
igor@402
|
868 \dirname{/my/root} from the name, and publish the repository with a
|
|
igor@402
|
869 virtual path of \dirname{this/repo}. If the base URL for our CGI
|
|
igor@402
|
870 script is \url{http://myhostname/~myuser/hgwebdir.cgi}, the complete
|
|
igor@402
|
871 URL for that repository will be
|
|
igor@402
|
872 \url{http://myhostname/~myuser/hgwebdir.cgi/this/repo}.
|
|
igor@402
|
873
|
|
igor@402
|
874 If we replace \dirname{/my/root} on the left hand side of this example
|
|
igor@402
|
875 with \dirname{/my}, then \sfilename{hgwebdir.cgi} will only strip off
|
|
igor@402
|
876 \dirname{/my} from the repository name, and will give us a virtual
|
|
igor@402
|
877 path of \dirname{root/this/repo} instead of \dirname{this/repo}.
|
|
igor@402
|
878
|
|
igor@402
|
879 The \sfilename{hgwebdir.cgi} script will recursively search each
|
|
igor@402
|
880 directory listed in the \texttt{collections} section of its
|
|
igor@402
|
881 configuration file, but it will \texttt{not} recurse into the
|
|
igor@402
|
882 repositories it finds.
|
|
igor@402
|
883
|
|
igor@402
|
884 The \texttt{collections} mechanism makes it easy to publish many
|
|
igor@402
|
885 repositories in a ``fire and forget'' manner. You only need to set up
|
|
igor@402
|
886 the CGI script and configuration file one time. Afterwards, you can
|
|
igor@402
|
887 publish or unpublish a repository at any time by simply moving it
|
|
igor@402
|
888 into, or out of, the directory hierarchy in which you've configured
|
|
igor@402
|
889 \sfilename{hgwebdir.cgi} to look.
|
|
igor@402
|
890
|
|
igor@402
|
891 \subsubsection{Explicitly specifying which repositories to publish}
|
|
igor@402
|
892
|
|
igor@402
|
893 In addition to the \texttt{collections} mechanism, the
|
|
igor@402
|
894 \sfilename{hgwebdir.cgi} script allows you to publish a specific list
|
|
igor@402
|
895 of repositories. To do so, create a \texttt{paths} section, with
|
|
igor@402
|
896 contents of the following form.
|
|
igor@402
|
897 \begin{codesample2}
|
|
igor@402
|
898 [paths]
|
|
igor@402
|
899 repo1 = /my/path/to/some/repo
|
|
igor@402
|
900 repo2 = /some/path/to/another
|
|
igor@402
|
901 \end{codesample2}
|
|
igor@402
|
902 In this case, the virtual path (the component that will appear in a
|
|
igor@402
|
903 URL) is on the left hand side of each definition, while the path to
|
|
igor@402
|
904 the repository is on the right. Notice that there does not need to be
|
|
igor@402
|
905 any relationship between the virtual path you choose and the location
|
|
igor@402
|
906 of a repository in your filesystem.
|
|
igor@402
|
907
|
|
igor@402
|
908 If you wish, you can use both the \texttt{collections} and
|
|
igor@402
|
909 \texttt{paths} mechanisms simultaneously in a single configuration
|
|
igor@402
|
910 file.
|
|
igor@402
|
911
|
|
igor@402
|
912 \begin{note}
|
|
igor@402
|
913 If multiple repositories have the same virtual path,
|
|
igor@402
|
914 \sfilename{hgwebdir.cgi} will not report an error. Instead, it will
|
|
igor@402
|
915 behave unpredictably.
|
|
igor@402
|
916 \end{note}
|
|
igor@402
|
917
|
|
igor@402
|
918 \subsection{Downloading source archives}
|
|
igor@402
|
919
|
|
igor@402
|
920 Mercurial's web interface lets users download an archive of any
|
|
igor@402
|
921 revision. This archive will contain a snapshot of the working
|
|
igor@402
|
922 directory as of that revision, but it will not contain a copy of the
|
|
igor@402
|
923 repository data.
|
|
igor@402
|
924
|
|
igor@402
|
925 By default, this feature is not enabled. To enable it, you'll need to
|
|
igor@402
|
926 add an \rcitem{web}{allow\_archive} item to the \rcsection{web}
|
|
igor@402
|
927 section of your \hgrc.
|
|
igor@402
|
928
|
|
igor@402
|
929 \subsection{Web configuration options}
|
|
igor@402
|
930
|
|
igor@402
|
931 Mercurial's web interfaces (the \hgcmd{serve} command, and the
|
|
igor@402
|
932 \sfilename{hgweb.cgi} and \sfilename{hgwebdir.cgi} scripts) have a
|
|
igor@402
|
933 number of configuration options that you can set. These belong in a
|
|
igor@402
|
934 section named \rcsection{web}.
|
|
igor@402
|
935 \begin{itemize}
|
|
igor@402
|
936 \item[\rcitem{web}{allow\_archive}] Determines which (if any) archive
|
|
igor@402
|
937 download mechanisms Mercurial supports. If you enable this
|
|
igor@402
|
938 feature, users of the web interface will be able to download an
|
|
igor@402
|
939 archive of whatever revision of a repository they are viewing.
|
|
igor@402
|
940 To enable the archive feature, this item must take the form of a
|
|
igor@402
|
941 sequence of words drawn from the list below.
|
|
igor@402
|
942 \begin{itemize}
|
|
igor@402
|
943 \item[\texttt{bz2}] A \command{tar} archive, compressed using
|
|
igor@402
|
944 \texttt{bzip2} compression. This has the best compression ratio,
|
|
igor@402
|
945 but uses the most CPU time on the server.
|
|
igor@402
|
946 \item[\texttt{gz}] A \command{tar} archive, compressed using
|
|
igor@402
|
947 \texttt{gzip} compression.
|
|
igor@402
|
948 \item[\texttt{zip}] A \command{zip} archive, compressed using LZW
|
|
igor@402
|
949 compression. This format has the worst compression ratio, but is
|
|
igor@402
|
950 widely used in the Windows world.
|
|
igor@402
|
951 \end{itemize}
|
|
igor@402
|
952 If you provide an empty list, or don't have an
|
|
igor@402
|
953 \rcitem{web}{allow\_archive} entry at all, this feature will be
|
|
igor@402
|
954 disabled. Here is an example of how to enable all three supported
|
|
igor@402
|
955 formats.
|
|
igor@402
|
956 \begin{codesample4}
|
|
igor@402
|
957 [web]
|
|
igor@402
|
958 allow_archive = bz2 gz zip
|
|
igor@402
|
959 \end{codesample4}
|
|
igor@402
|
960 \item[\rcitem{web}{allowpull}] Boolean. Determines whether the web
|
|
igor@402
|
961 interface allows remote users to \hgcmd{pull} and \hgcmd{clone} this
|
|
igor@402
|
962 repository over~HTTP. If set to \texttt{no} or \texttt{false}, only
|
|
igor@402
|
963 the ``human-oriented'' portion of the web interface is available.
|
|
igor@402
|
964 \item[\rcitem{web}{contact}] String. A free-form (but preferably
|
|
igor@402
|
965 brief) string identifying the person or group in charge of the
|
|
igor@402
|
966 repository. This often contains the name and email address of a
|
|
igor@402
|
967 person or mailing list. It often makes sense to place this entry in
|
|
igor@402
|
968 a repository's own \sfilename{.hg/hgrc} file, but it can make sense
|
|
igor@402
|
969 to use in a global \hgrc\ if every repository has a single
|
|
igor@402
|
970 maintainer.
|
|
igor@402
|
971 \item[\rcitem{web}{maxchanges}] Integer. The default maximum number
|
|
igor@402
|
972 of changesets to display in a single page of output.
|
|
igor@402
|
973 \item[\rcitem{web}{maxfiles}] Integer. The default maximum number
|
|
igor@402
|
974 of modified files to display in a single page of output.
|
|
igor@402
|
975 \item[\rcitem{web}{stripes}] Integer. If the web interface displays
|
|
igor@402
|
976 alternating ``stripes'' to make it easier to visually align rows
|
|
igor@402
|
977 when you are looking at a table, this number controls the number of
|
|
igor@402
|
978 rows in each stripe.
|
|
igor@402
|
979 \item[\rcitem{web}{style}] Controls the template Mercurial uses to
|
|
igor@402
|
980 display the web interface. Mercurial ships with two web templates,
|
|
igor@402
|
981 named \texttt{default} and \texttt{gitweb} (the latter is much more
|
|
igor@402
|
982 visually attractive). You can also specify a custom template of
|
|
igor@402
|
983 your own; see chapter~\ref{chap:template} for details. Here, you
|
|
igor@402
|
984 can see how to enable the \texttt{gitweb} style.
|
|
igor@402
|
985 \begin{codesample4}
|
|
igor@402
|
986 [web]
|
|
igor@402
|
987 style = gitweb
|
|
igor@402
|
988 \end{codesample4}
|
|
igor@402
|
989 \item[\rcitem{web}{templates}] Path. The directory in which to search
|
|
igor@402
|
990 for template files. By default, Mercurial searches in the directory
|
|
igor@402
|
991 in which it was installed.
|
|
igor@402
|
992 \end{itemize}
|
|
igor@402
|
993 If you are using \sfilename{hgwebdir.cgi}, you can place a few
|
|
igor@402
|
994 configuration items in a \rcsection{web} section of the
|
|
igor@402
|
995 \sfilename{hgweb.config} file instead of a \hgrc\ file, for
|
|
igor@402
|
996 convenience. These items are \rcitem{web}{motd} and
|
|
igor@402
|
997 \rcitem{web}{style}.
|
|
igor@402
|
998
|
|
igor@402
|
999 \subsubsection{Options specific to an individual repository}
|
|
igor@402
|
1000
|
|
igor@402
|
1001 A few \rcsection{web} configuration items ought to be placed in a
|
|
igor@402
|
1002 repository's local \sfilename{.hg/hgrc}, rather than a user's or
|
|
igor@402
|
1003 global \hgrc.
|
|
igor@402
|
1004 \begin{itemize}
|
|
igor@402
|
1005 \item[\rcitem{web}{description}] String. A free-form (but preferably
|
|
igor@402
|
1006 brief) string that describes the contents or purpose of the
|
|
igor@402
|
1007 repository.
|
|
igor@402
|
1008 \item[\rcitem{web}{name}] String. The name to use for the repository
|
|
igor@402
|
1009 in the web interface. This overrides the default name, which is the
|
|
igor@402
|
1010 last component of the repository's path.
|
|
igor@402
|
1011 \end{itemize}
|
|
igor@402
|
1012
|
|
igor@402
|
1013 \subsubsection{Options specific to the \hgcmd{serve} command}
|
|
igor@402
|
1014
|
|
igor@402
|
1015 Some of the items in the \rcsection{web} section of a \hgrc\ file are
|
|
igor@402
|
1016 only for use with the \hgcmd{serve} command.
|
|
igor@402
|
1017 \begin{itemize}
|
|
igor@402
|
1018 \item[\rcitem{web}{accesslog}] Path. The name of a file into which to
|
|
igor@402
|
1019 write an access log. By default, the \hgcmd{serve} command writes
|
|
igor@402
|
1020 this information to standard output, not to a file. Log entries are
|
|
igor@402
|
1021 written in the standard ``combined'' file format used by almost all
|
|
igor@402
|
1022 web servers.
|
|
igor@402
|
1023 \item[\rcitem{web}{address}] String. The local address on which the
|
|
igor@402
|
1024 server should listen for incoming connections. By default, the
|
|
igor@402
|
1025 server listens on all addresses.
|
|
igor@402
|
1026 \item[\rcitem{web}{errorlog}] Path. The name of a file into which to
|
|
igor@402
|
1027 write an error log. By default, the \hgcmd{serve} command writes this
|
|
igor@402
|
1028 information to standard error, not to a file.
|
|
igor@402
|
1029 \item[\rcitem{web}{ipv6}] Boolean. Whether to use the IPv6 protocol.
|
|
igor@402
|
1030 By default, IPv6 is not used.
|
|
igor@402
|
1031 \item[\rcitem{web}{port}] Integer. The TCP~port number on which the
|
|
igor@402
|
1032 server should listen. The default port number used is~8000.
|
|
igor@402
|
1033 \end{itemize}
|
|
igor@402
|
1034
|
|
igor@402
|
1035 \subsubsection{Choosing the right \hgrc\ file to add \rcsection{web}
|
|
igor@402
|
1036 items to}
|
|
igor@402
|
1037
|
|
igor@402
|
1038 It is important to remember that a web server like Apache or
|
|
igor@402
|
1039 \texttt{lighttpd} will run under a user~ID that is different to yours.
|
|
igor@402
|
1040 CGI scripts run by your server, such as \sfilename{hgweb.cgi}, will
|
|
igor@402
|
1041 usually also run under that user~ID.
|
|
igor@402
|
1042
|
|
igor@402
|
1043 If you add \rcsection{web} items to your own personal \hgrc\ file, CGI
|
|
igor@402
|
1044 scripts won't read that \hgrc\ file. Those settings will thus only
|
|
igor@402
|
1045 affect the behaviour of the \hgcmd{serve} command when you run it. To
|
|
igor@402
|
1046 cause CGI scripts to see your settings, either create a \hgrc\ file in
|
|
igor@402
|
1047 the home directory of the user ID that runs your web server, or add
|
|
igor@402
|
1048 those settings to a system-wide \hgrc\ file.
|
|
igor@402
|
1049
|
|
igor@402
|
1050
|
|
igor@402
|
1051 %%% Local Variables:
|
|
igor@402
|
1052 %%% mode: latex
|
|
igor@402
|
1053 %%% TeX-master: "00book"
|
|
igor@402
|
1054 %%% End:
|
