From: <fxp...@us...> - 2009-03-29 19:29:56
|
Revision: 2729 http://geonetwork.svn.sourceforge.net/geonetwork/?rev=2729&view=rev Author: fxprunayre Date: 2009-03-29 19:29:49 +0000 (Sun, 29 Mar 2009) Log Message: ----------- Added CSW main configuration options documentation from admin UI. Modified Paths: -------------- trunk/docs/docbook/gn_manual/admin_basic_configuration.xml trunk/docs/docbook/gn_manual/images/admin/web-config-options.png trunk/docs/docbook/gn_manual_fra/admin_basic_configuration.xml trunk/docs/docbook/gn_manual_fra/images/admin/web-config-options.png Modified: trunk/docs/docbook/gn_manual/admin_basic_configuration.xml =================================================================== --- trunk/docs/docbook/gn_manual/admin_basic_configuration.xml 2009-03-29 14:15:50 UTC (rev 2728) +++ trunk/docs/docbook/gn_manual/admin_basic_configuration.xml 2009-03-29 19:29:49 UTC (rev 2729) @@ -27,61 +27,11 @@ </imageobject> </mediaobject> </figure> - + <para>Clicking the page’s link you will get the set of parameters that you can change - (<xref linkend="admin_config_options"/>). Here follows a detailed description of + (<xref linkend="admin_config_options"/>). Here follows a detailed description of them: </para> - <para>Site General site parameters.</para> - <para><emphasis>Name</emphasis> The name of the GeoNetwork’s installation. This name - will be used to identify the node in operations like the harvesting.</para> - <para><emphasis>organization</emphasis> The organization the node belongs to. Just for - informative reasons.</para> - <para><emphasis>Server</emphasis> Here you have to enter the address of your - GeoNetwork’s node. This address is important because it will be used to access the - node. </para> - <para><emphasis>Host</emphasis> The node’s address or IP number. If your node is - publicly accessible from the Internet, you have to use the machine’s domain/address. - If your node is hidden into your private network and you have a firewall or web - server that redirects incoming calls to the node, you have to enter the public - address of the firewall or web server. A typical configuration is to have an Apache - web server on address A that is publicly accessible and redirects the requests to a - Tomcat server on a private address B. In this case you have to enter A in the host - parameter.</para> - <para><emphasis>port</emphasis> The node’s port (usually 80 or 8080). If the node is - hidden, you have to enter the port on the public firewall or web server.</para> - <para><emphasis>Intranet</emphasis> A common need for an organization is to discriminate - between internal anonymous users (users that access the node from within the - organization) and external ones (users from the Internet). Node’s administrators can - specify different privileges for internal and external anonymous users and, in order - to do so, they have to specify the parameters of the internal network. </para> - <para><emphasis>Network</emphasis> The internal network’s address in IP form.</para> - <para><emphasis>netmask</emphasis> The network’s mask.</para> - <para><emphasis>Z39.50</emphasis> GeoNetwork can act as a Z39.50 server, which is an OGC - communication protocol to query and retrieve metadata. </para> - <para><emphasis>Enable</emphasis> Check this option to start the Z39.50 submodule. - Please, notice that GeoNetwork must be restarted in order to make this change - active.</para> - <para><emphasis>port</emphasis> This is the port on which GeoNetwork will be listening - for incoming Z39.50 requests. Usually, the value of 2100 is a standard one, but to - have multiple GeoNetwork nodes on the same machine you have to change this value in - order to avoid port conflicts between the different nodes.</para> - <para><emphasis>Proxy</emphasis> In some occasions (like harvesting) GeoNetwork must be - able to connect to remote sites and this may be denied if an organization uses proxy - servers. In this cases, GeoNetwork must be configured to use the proxy server in - order to route outgoing requests. </para> - <para><emphasis>Host</emphasis> The proxy’s name or address to use (usually an IP - address).</para> - <para><emphasis>port</emphasis> The proxy’s port to use.</para> - <para><emphasis>Feedback</emphasis> GeoNetwork can provide some feedback to the - administrator if some events happen, for example a metadata is downloaded or some - feedback is provided using the online form. You have to configure GeoNetwork with - proper parameters to send an email. </para> - <para><emphasis>Email</emphasis> This is the email address that will be used to send - feedback to the administrator.</para> - <para><emphasis>SMTP host</emphasis> Organization’s mail server to use when sending - emails</para> - <para><emphasis>SMTP port</emphasis> Mail server’s SMTP port (usually 25). </para> - + <figure id="admin_config_options"> <title>The configuration options</title> <mediaobject> @@ -115,6 +65,125 @@ the host and port values.</para> </listitem> </orderedlist> + + <section> + <title>Site General site parameters.</title> + <para><emphasis>Name</emphasis> The name of the GeoNetwork’s installation. This name + will be used to identify the node in operations like the harvesting.</para> + <para><emphasis>organization</emphasis> The organization the node belongs to. Just + for informative reasons.</para> + <para><emphasis>Server</emphasis> Here you have to enter the address of your + GeoNetwork’s node. This address is important because it will be used to access + the node. </para> + <para><emphasis>Host</emphasis> The node’s address or IP number. If your node is + publicly accessible from the Internet, you have to use the machine’s + domain/address. If your node is hidden into your private network and you have a + firewall or web server that redirects incoming calls to the node, you have to + enter the public address of the firewall or web server. A typical configuration + is to have an Apache web server on address A that is publicly accessible and + redirects the requests to a Tomcat server on a private address B. In this case + you have to enter A in the host parameter.</para> + <para><emphasis>port</emphasis> The node’s port (usually 80 or 8080). If the node is + hidden, you have to enter the port on the public firewall or web server.</para> + <para><emphasis>Intranet</emphasis> A common need for an organization is to + discriminate between internal anonymous users (users that access the node from + within the organization) and external ones (users from the Internet). Node’s + administrators can specify different privileges for internal and external + anonymous users and, in order to do so, they have to specify the parameters of + the internal network. </para> + <para><emphasis>Network</emphasis> The internal network’s address in IP form.</para> + <para><emphasis>netmask</emphasis> The network’s mask.</para> + </section> + <section> + <title>Remote connection (CSW, Z39.50)</title> + <section> + <title>CSW configuration</title> + <para>When using CSW service, a client will ask for a description of the + service. This description also known as GetCapabilities document, describes + the main service's properties. The administration section allows + configuration of the following CSW properties:</para> + <orderedlist> + <listitem> + <para><emphasis>Enable</emphasis> option allows you to turn on/off CSW + services. If this option is disabled, other catalogues could not + connect to the node using CSW protocol.</para> + </listitem> + <listitem> + <para> + <emphasis>Contact</emphasis> is the main contact who is defined in + the GetCapabilities document of the CSW service. This contact is one + user of the catalogue. </para> + </listitem> + <listitem> + <para> + <emphasis>Title</emphasis> is the title of your CSW service. </para> + </listitem> + <listitem> + <para> + <emphasis>Abstract</emphasis> is the abstract of your CSW service. + </para> + </listitem> + <listitem> + <para> + <emphasis>Fees</emphasis> + </para> + </listitem> + <listitem> + <para> + <emphasis>Access constraints</emphasis> + </para> + </listitem> + </orderedlist> + <para>The service description also contains the main keywords of the catalogue. + The list of keywords is generated by the catalogue based on metadata + content.</para> + <!-- TODO : Add documentation about config-csw.xml options --> + </section> + <section> + <title>Z39.50 configuration</title> + <para><emphasis>Z39.50</emphasis> GeoNetwork can act as a Z39.50 server, which + is an OGC communication protocol to query and retrieve metadata. </para> + <para><emphasis>Enable</emphasis> Check this option to start the Z39.50 + submodule. Please, notice that GeoNetwork must be restarted in order to make + this change active.</para> + <para><emphasis>port</emphasis> This is the port on which GeoNetwork will be + listening for incoming Z39.50 requests. Usually, the value of 2100 is a + standard one, but to have multiple GeoNetwork nodes on the same machine you + have to change this value in order to avoid port conflicts between the + different nodes.</para> + </section> + </section> + <section> + <title>Proxy configuration</title> + <para><emphasis>Proxy</emphasis> In some occasions (like harvesting) GeoNetwork must + be able to connect to remote sites and this may be denied if an organization + uses proxy servers. In this cases, GeoNetwork must be configured to use the + proxy server in order to route outgoing requests. </para> + <para><emphasis>Host</emphasis> The proxy’s name or address to use (usually an IP + address).</para> + <para><emphasis>port</emphasis> The proxy’s port to use.</para> + </section> + <section> + <title>Email & notification</title> + <para><emphasis>Feedback</emphasis> GeoNetwork can provide some feedback to the + administrator if some events happen, for example a metadata is downloaded or + some feedback is provided using the online form. You have to configure + GeoNetwork with proper parameters to send an email. </para> + <para><emphasis>Email</emphasis> This is the email address that will be used to send + feedback to the administrator.</para> + <para><emphasis>SMTP host</emphasis> Organization’s mail server to use when sending + emails</para> + <para><emphasis>SMTP port</emphasis> Mail server’s SMTP port (usually 25). </para> + </section> + <section> + <title>Removed metadata</title> + <para>Defined the directory to use to store removed metadata on delete actions. This + is used as a backup directory.</para> + </section> + <section> + <title>LDAP Authentication</title> + <para>This section define how to connect LDAP authentication system.</para> + </section> </section> </chapter> -</book> \ No newline at end of file +</book> Modified: trunk/docs/docbook/gn_manual/images/admin/web-config-options.png =================================================================== (Binary files differ) Modified: trunk/docs/docbook/gn_manual_fra/admin_basic_configuration.xml =================================================================== --- trunk/docs/docbook/gn_manual_fra/admin_basic_configuration.xml 2009-03-29 14:15:50 UTC (rev 2728) +++ trunk/docs/docbook/gn_manual_fra/admin_basic_configuration.xml 2009-03-29 19:29:49 UTC (rev 2729) @@ -31,91 +31,8 @@ <para>En cliquant sur le lien vous obtenez la liste des paramètres que vous pouvez modifier (<xref linkend="admin_config_options"/>). Ces paramètres sont décris de la manière suivante : </para> - <para>Paramètre général du site. </para> - <orderedlist> - <listitem> - <para>nom : Le nom de l'installation de GeoNetwork. Ce nom sera utilisé pour - identifier le noeud dans les opérations tel que le moissonage.</para> - </listitem> - <listitem> - <para>organisation : L'organisation à laquelle le noeud appartient. Uniquement - informatif.</para> - </listitem> - </orderedlist> - <para>Serveur. </para> - <orderedlist> - <listitem> - <para>hôte : L'adresse du noeud GeoNetwork. Cette adresse est importante car - utilisée pour l'accès au catalogue. L'adresse du noeud ou son adresse IP - peut être saisie. Si le noeud est public (ie. accessible sur Internet) vous - devez utiliser le nom de domaine du serveur. Si le noeud est placé sur un - réseau privé et que vous avez un parfeu ou un serveur web s'occupant des - redirections (ie. reverse proxy) dans ce cas vous devez saisir l'adresse du - parfeu ou serveur web accessible depuis Internet.</para> - </listitem> - <listitem> - <para>Port : Le numéro du port (habituellement 80 ou 8080).</para> - </listitem> - </orderedlist> - <para>Intranet : Un besoin fréquent est de pouvoir distinguer un utilisateur Internet - d'un utilisateur Intranet (ie. sur le réseau local). Les privilèges sur les - métadonnées peuvent être définis pour ces 2 types d'utilisateurs. Pour cela, les - paramètres suivants doivent être renseignés. </para> - <orderedlist> - <listitem> - <para>réseau : L'adresse IP du réseau.</para> - </listitem> - <listitem> - <para>masque de sous réseau.</para> - </listitem> - </orderedlist> - - - <para>Serveur Z39.50 : GeoNetwork peut être un serveur Z39.50. Activez cette option en - cochant la case.</para> - <orderedlist> - <listitem> - <para>Cochez cette option pour activer le module. Attention, vous devez - redémarrer GeoNetwork pour activer cette fonction.</para> - </listitem> - <listitem> - <para>port : Cette option définie le port sur lequel GeoNetwork écoute les - requêtes Z39.50. En général, la valeur est 2100. Celle-ci est la plus - commune pour le serveur Z39.50. Cependant, si vous souhaitez déployer - plusieurs noeuds GeoNetwork, vous devez utiliser des ports différents afin - d'éviter les conflits de ports. Par ailleurs, dans le cas où le noeud est - localisé derrière un proxy, il est nécessaire de le configurer afin de - router les requêtes.</para> - </listitem> - </orderedlist> - - <para>Proxy</para> - <orderedlist> - <listitem> - <para>host : Le nom ou l'adresse IP du proxy.</para> - </listitem> - <listitem> - <para>port : Le port à utiliser.</para> - </listitem> - </orderedlist> - - <para>Alerte par email : GeoNetwork peut envoyer des messages à l'administrateur du - noeud sur certains événements tel que le téléchargement des données ou l'utilisation - du formulaire Contact. Pour cela, vous devez configurer GeoNetwork.</para> - <orderedlist> - <listitem> - <para>email : L'adresse email à laquelle les alertes sont envoyées.</para> - </listitem> - <listitem> - <para>serveur SMTP : Le serveur SMTP devant être utilisé.</para> - </listitem> - <listitem> - <para>port SMTP : Le port SMTP devant être utilisé (en général 25).</para> - </listitem> - </orderedlist> - <figure id="admin_config_options"> <title>Options de configuration</title> <mediaobject> @@ -158,6 +75,157 @@ paramètres.</para> </listitem> </orderedlist> + + + <section> + <title>Paramètre général du site. </title> + <orderedlist> + <listitem> + <para>nom : Le nom de l'installation de GeoNetwork. Ce nom sera utilisé pour + identifier le noeud dans les opérations tel que le moissonage.</para> + </listitem> + <listitem> + <para>organisation : L'organisation à laquelle le noeud appartient. + Uniquement informatif.</para> + </listitem> + </orderedlist> + </section> + <section> + <title>Serveur.</title> + <orderedlist> + <listitem> + <para>hôte : L'adresse du noeud GeoNetwork. Cette adresse est importante car + utilisée pour l'accès au catalogue. L'adresse du noeud ou son adresse IP + peut être saisie. Si le noeud est public (ie. accessible sur Internet) + vous devez utiliser le nom de domaine du serveur. Si le noeud est placé + sur un réseau privé et que vous avez un parfeu ou un serveur web + s'occupant des redirections (ie. reverse proxy) dans ce cas vous devez + saisir l'adresse du parfeu ou serveur web accessible depuis + Internet.</para> + </listitem> + <listitem> + <para>Port : Le numéro du port (habituellement 80 ou 8080).</para> + </listitem> + </orderedlist> + + <para>Intranet : Un besoin fréquent est de pouvoir distinguer un utilisateur + Internet d'un utilisateur Intranet (ie. sur le réseau local). Les privilèges sur + les métadonnées peuvent être définis pour ces 2 types d'utilisateurs. Pour cela, + les paramètres suivants doivent être renseignés. </para> + <orderedlist> + <listitem> + <para>réseau : L'adresse IP du réseau.</para> + </listitem> + <listitem> + <para>masque de sous réseau.</para> + </listitem> + </orderedlist> + </section> + + <section> + <title>Connection distante (CSW, Z39.50)</title> + <section> + <title>Configuration du service CSW</title> + <para>Lors de l'utilisation du service CSW, les clients demandent une + description du service. Cette description est accessible via le document + GetCapabilities transmis par le service. La configuration du service CSW + permet la définition des propriétés suivantes :</para> + <orderedlist> + <listitem> + <para><emphasis>Activer</emphasis> permet d'activer ou pas le service. + Si inactif, les autres catalogues ne peuvent se connecter au + catalogue via CSW.</para> + </listitem> + <listitem> + <para> + <emphasis>Contact</emphasis> permet de définir le contact pour le + service. Ce contact est un utilisateur définit dans les utilisateurs + du catalogue.</para> + </listitem> + <listitem> + <para> + <emphasis>Titre</emphasis> permet de décrire le service. </para> + </listitem> + <listitem> + <para> + <emphasis>Abstract</emphasis> correspond au résumé. Il peut indiquer + la couverture géographique et thématique du catalogue. </para> + </listitem> + <listitem> + <para> + <emphasis>Fees</emphasis> + </para> + </listitem> + <listitem> + <para> + <emphasis>Access constraints</emphasis> / Contrainte d'accès + </para> + </listitem> + </orderedlist> + <para>La description du service contient également des mots clés. Ces mots-clés + sont automatiquement définis par le catalogue à partir des mots clés les + plus fréquent dans le catalogue.</para> + <!-- TODO : Add documentation about config-csw.xml options --> + </section> + <section> + <title>Serveur Z39.50</title> + <para>Serveur Z39.50 : GeoNetwork peut être un serveur Z39.50. Activez cette + option en cochant la case.</para> + <orderedlist> + <listitem> + <para>Cochez cette option pour activer le module. Attention, vous devez + redémarrer GeoNetwork pour activer cette fonction.</para> + </listitem> + <listitem> + <para>port : Cette option définie le port sur lequel GeoNetwork écoute + les requêtes Z39.50. En général, la valeur est 2100. Celle-ci est la + plus commune pour le serveur Z39.50. Cependant, si vous souhaitez + déployer plusieurs noeuds GeoNetwork, vous devez utiliser des ports + différents afin d'éviter les conflits de ports. Par ailleurs, dans + le cas où le noeud est localisé derrière un proxy, il est nécessaire + de le configurer afin de router les requêtes.</para> + </listitem> + </orderedlist> + </section> + </section> + <section> + <title>Configuration du proxy</title> + <orderedlist> + <listitem> + <para>host : Le nom ou l'adresse IP du proxy.</para> + </listitem> + <listitem> + <para>port : Le port à utiliser.</para> + </listitem> + </orderedlist> + </section> + <section> + <title>Notification &s; email</title> + <para>Alerte par email : GeoNetwork peut envoyer des messages à l'administrateur du + noeud sur certains événements tel que le téléchargement des données ou + l'utilisation du formulaire Contact. Pour cela, vous devez configurer + GeoNetwork.</para> + <orderedlist> + <listitem> + <para>email : L'adresse email à laquelle les alertes sont envoyées.</para> + </listitem> + <listitem> + <para>serveur SMTP : Le serveur SMTP devant être utilisé.</para> + </listitem> + <listitem> + <para>port SMTP : Le port SMTP devant être utilisé (en général 25).</para> + </listitem> + </orderedlist> + </section> + <section> + <title>Métadonnées supprimées</title> + <para>Définir le répertoire utilisé pour stocker les métadonnées + supprimées.</para> + </section> + <section> + <title>Authentification LDAP</title> + <para>Propriété de la connection à un serveur LDAP.</para> + </section> </section> </chapter> </book> Modified: trunk/docs/docbook/gn_manual_fra/images/admin/web-config-options.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |