diff options
| author | Joe Rayhawk <jrayhawk@freedesktop.org> | 2013-04-23 21:19:42 -0700 |
|---|---|---|
| committer | Joe Rayhawk <jrayhawk@freedesktop.org> | 2013-04-23 21:19:42 -0700 |
| commit | 9646c9e7d9f6d95f101e92e83fd994b17907b8bf (patch) | |
| tree | 834dd3f8c6822cf13e812fb746ea703dd1e41174 | |
| parent | 7affd55a37a48e6afd7e08dd8c01893a8ca0fb05 (diff) | |
moin2iki: correcting preformatted text
| -rw-r--r-- | Apoc/Documentation/BuildingInstructions.mdwn | 120 | ||||
| -rw-r--r-- | Apoc/Documentation/Dependencies.mdwn | 5 | ||||
| -rw-r--r-- | Apoc/Documentation/InstallingGit.mdwn | 16 | ||||
| -rw-r--r-- | Apoc/Documentation/ProfileEditor.mdwn | 8 | ||||
| -rw-r--r-- | Apoc/Documentation/TroubleShooting.mdwn | 28 | ||||
| -rw-r--r-- | Apoc/Downloads.mdwn | 33 | ||||
| -rw-r--r-- | ApocDocumentation/TroubleShooting.mdwn | 10 |
7 files changed, 81 insertions, 139 deletions
diff --git a/Apoc/Documentation/BuildingInstructions.mdwn b/Apoc/Documentation/BuildingInstructions.mdwn index 3077f9e..8cdfc35 100644 --- a/Apoc/Documentation/BuildingInstructions.mdwn +++ b/Apoc/Documentation/BuildingInstructions.mdwn @@ -19,10 +19,8 @@ The following steps should be completed in the root directory of your apoc-spi l /!\ **NOTE**: Tarball releases already include a configure script so this step is unnecessary in that case. + $ ./autogen.sh --help -[[!format txt """ -$ ./autogen.sh --help -"""]] If no errors occur, the configure script will be generated successfully and its help output would be shown. @@ -30,20 +28,18 @@ If no errors occur, the configure script will be generated successfully and its In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. + $ ./configure --prefix=/usr --with-ns-ldap-path=/path/to/ldapjdk.jar -[[!format txt """ -$ ./configure --prefix=/usr --with-ns-ldap-path=/path/to/ldapjdk.jar -"""]] /!\ **NOTE**: We assume here that java, javac and ant are in the binary path. The ldapjdk.jar would be looked by default on /usr/share/lib/apoc/ldapjdk.jar, it can be located elsewhere, use the --with-ns-ldap-path option used in the example for any other location. ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make -$ make install -"""]] + + $ make + $ make install + Once complete, the SPI jar file, spi.jar should be available under your prefix directory as share/lib/apoc/spi.jar. @@ -60,30 +56,23 @@ Check [[the dependencies section|Apoc/Documentation/Dependencies]] before to pro First, make sure you have installed the software listed in the [[dependencies section|Apoc/Dependencies]], type this to generate the configure script: - -[[!format txt """ -$ ./autogen.sh --help -"""]] + $ ./autogen.sh --help ### Step 2: Calling the configure script In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. + $ ./configure --prefix=/usr --with-bdb-path=/path/to/db.jar -[[!format txt """ -$ ./configure --prefix=/usr \ - --with-bdb-path=/path/to/db.jar -"""]] /!\ **NOTE**: You should use the same prefix than the SPI, otherwise you need to set the --with-apoc-dir option. The db.jar would be looked by default on /usr/share/lib/apoc/db.jar, it can be located elsewhere, use the --with-bdb-path option used in the example for any other location. ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make -$ make install -"""]] + + $ make + $ make install ### Post Installation @@ -103,10 +92,8 @@ The following steps should be completed in the root directory of your apoc-templ Type this in the root path of the source code to generate the configure script: + $ ./autogen.sh --help -[[!format txt """ -$ ./autogen.sh --help -"""]] If no errors occur, the configure script will be generated successfully and its help output would be shown. @@ -114,17 +101,13 @@ If no errors occur, the configure script will be generated successfully and its In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. - -[[!format txt """ -$ ./configure --prefix=/usr -"""]] + $ ./configure --prefix=/usr ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make install -"""]] + + $ make install ## Profile Editor @@ -139,10 +122,8 @@ The profile editor depends on the SPI and the Template Packages. Type this in the root path of the source code to generate the configure script: + $ ./autogen.sh --help -[[!format txt """ -$ ./autogen.sh --help -"""]] If no errors occur, the configure script will be generated successfully and its help output would be shown. @@ -150,20 +131,17 @@ If no errors occur, the configure script will be generated successfully and its In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. + $ ./configure --prefix=/usr -[[!format txt """ -$ ./configure --prefix=/usr -"""]] /!\ **NOTE**: You should use the same prefix than the SPI. ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make -$ make install -"""]] + + $ make + $ make install ## Desktop Manager @@ -178,10 +156,8 @@ Check [[the dependencies section|Apoc/Documentation/Dependencies]] before to pro Type this in the root path of the source code to generate the configure script: + $ ./autogen.sh --help -[[!format txt """ -$ ./autogen.sh --help -"""]] If no errors occur, the configure script will be generated successfully and its help output would be shown. @@ -189,46 +165,38 @@ If no errors occur, the configure script will be generated successfully and its In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. + $ ./configure --prefix=/usr \ + --with-webconsole-prefix=/opt/sun/webconsole \ + --with-jato-path=/opt/sun/share/lib/jato.jar \ + --with-ns-ldap-path=/usr/share/lib/java/ldapjdk.jar -[[!format txt """ -$ ./configure --prefix=/usr \ - --with-webconsole-prefix=/opt/sun/webconsole \ - --with-jato-path=/opt/sun/share/lib/jato.jar \ - --with-ns-ldap-path=/usr/share/lib/java/ldapjdk.jar -"""]] /!\ **NOTE**: You should use the same prefix than the SPI, otherwise you need to set the --with-apoc-dir option. ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make -$ make install -"""]] + + $ make + $ make install ### Step 4: Post installation After installation, you should copy or make symbolic link from some files of the Java Web Console repository, the following example assumes that the webconsole is installed under /opt/sun/webconsole: + $ cd /opt/sun/webconsole/apoc + $ ln -s /opt/sun/webconsole/private/import/tld WEB-INF/ + $ ln -s /opt/sun/webconsole/private/import/lib/registrationservlet.jar WEB-INF/lib/ + $ ln -s /opt/sun/webconsole/private/import/help com_sun_web_ui/ + $ ln -s /opt/sun/webconsole/private/import/jsp com_sun_web_ui/ -[[!format txt """ -$ cd /opt/sun/webconsole/apoc -$ ln -s /opt/sun/webconsole/private/import/tld WEB-INF/ -$ ln -s /opt/sun/webconsole/private/import/lib/registrationservlet.jar WEB-INF/lib/ -$ ln -s /opt/sun/webconsole/private/import/help com_sun_web_ui/ -$ ln -s /opt/sun/webconsole/private/import/jsp com_sun_web_ui/ -"""]] Finally, you need to install the APOC Template Packages on the apoc/packages directory, if you have them installed already somewhere else, a symbolink link will work here as well: + $ ln -s /usr/share/apoc/packages /opt/sun/webconsole/apoc/packages -[[!format txt """ -$ ln -s /usr/share/apoc/packages /opt/sun/webconsole/apoc/packages -"""]] Finally you will have to deploy your app on the Java Web Console using the wcadmin command as root: -[[!format txt """ -$ wcadmin -a apoc -x apoc /opt/sun/webconsole/apoc -"""]] + + $ wcadmin -a apoc -x apoc /opt/sun/webconsole/apoc # Build the adapters @@ -240,10 +208,8 @@ $ wcadmin -a apoc -x apoc /opt/sun/webconsole/apoc /!\ **NOTE**: Tarball releases already include a configure script so this step is unnecessary in that case. + $ ./autogen.sh --help -[[!format txt """ -$ ./autogen.sh --help -"""]] If no errors occur, the configure script will be generated successfully and its help output would be shown. @@ -251,15 +217,11 @@ If no errors occur, the configure script will be generated successfully and its In the root path of the source code, you should execute the configure script. For more information on changing the default paths, execute configure with the --help option. - -[[!format txt """ -$ ./configure --prefix=/usr -"""]] + $ ./configure --prefix=/usr ### Step 3: Building the sources If the configuration ends successfully, then you should build and install the sources: -[[!format txt """ -$ make -$ make install -"""]]
\ No newline at end of file + + $ make + $ make install diff --git a/Apoc/Documentation/Dependencies.mdwn b/Apoc/Documentation/Dependencies.mdwn index 60b9e7c..d058f78 100644 --- a/Apoc/Documentation/Dependencies.mdwn +++ b/Apoc/Documentation/Dependencies.mdwn @@ -29,10 +29,7 @@ Here you can find a comprehensive list of dependencies and instructions on how t # Ubuntu Instructions - -[[!format txt """ -$ sudo apt-get install build-essential pkg-config automake-1.9 autoconf sun-java6-jdk ant libdb4.2-java-dev libgssapi4-heimdal heimdal-dev libxml2-dev -"""]] + $ sudo apt-get install build-essential pkg-config automake-1.9 autoconf sun-java6-jdk ant libdb4.2-java-dev libgssapi4-heimdal heimdal-dev libxml2-dev # Solaris Instructions diff --git a/Apoc/Documentation/InstallingGit.mdwn b/Apoc/Documentation/InstallingGit.mdwn index 7089314..8903c7c 100644 --- a/Apoc/Documentation/InstallingGit.mdwn +++ b/Apoc/Documentation/InstallingGit.mdwn @@ -8,16 +8,14 @@ Git is a distributed control management software used by the [[freedesktop.org|h ## Git on Ubuntu/Debian Look for the package git-core on the Synaptic package management tool, or typing this: -[[!format txt """ -$ sudo apt-get install git-core -"""]] + + $ sudo apt-get install git-core ## Git on Fedora Type this as root: -[[!format txt """ -# yum install git-core -"""]] + + # yum install git-core ## Git on Solaris @@ -30,11 +28,9 @@ Git for Solaris is available as a set of binary packages built from the [[Spec F Download the packages and execute as root: + # pkgadd -d SFEcurl-7.16.2-<os>-<platform>.pkg SFEcurl + # pkgadd -d SFEgit-1.5.2.2-<os>-<platform>.pkg SFEgit -[[!format txt """ -# pkgadd -d SFEcurl-7.16.2-<os>-<platform>.pkg SFEcurl -# pkgadd -d SFEgit-1.5.2.2-<os>-<platform>.pkg SFEgit -"""]] You might be asked to install SFEdiffutils here, just answer yes. diff --git a/Apoc/Documentation/ProfileEditor.mdwn b/Apoc/Documentation/ProfileEditor.mdwn index 408690b..3bfde26 100644 --- a/Apoc/Documentation/ProfileEditor.mdwn +++ b/Apoc/Documentation/ProfileEditor.mdwn @@ -1,5 +1,3 @@ - - # The Profile Editor [[!toc 2]] @@ -44,7 +42,7 @@ Copy the previously created zip file to `/usr/local/var/apoc/Policies/profiles/P Ensure that the Configuration Agent is configured to apply available local policies. To do this, set the `ApplyLocalPolicy` variable to yes in the `${ConfigDir}apocd.properties` file. `${ConfigDir} `corresponds to the value of the Desktop Agent's configuration directory which is /usr/local/etc by default. Now restart the Desktop Agent running: -[[!format txt """ -$ /usr/local/lib/apoc/apocd restart -"""]] + + $ /usr/local/lib/apoc/apocd restart + Any local policy deployed in this manner will be made available to clients during the next Configuration Agent change detection cycle. diff --git a/Apoc/Documentation/TroubleShooting.mdwn b/Apoc/Documentation/TroubleShooting.mdwn index 14d5cfd..d3c7b4a 100644 --- a/Apoc/Documentation/TroubleShooting.mdwn +++ b/Apoc/Documentation/TroubleShooting.mdwn @@ -106,10 +106,8 @@ To check that the LDAP server is running, run the command `ps -ef | grep slapd`. To ensure that the LDAP server has been properly setup, perform the following command: + ldapsearch [-x] -h <host> -p <port> -b ou=apocregistry,ou=default,ou=organizationconfig,ou=1.0,ou=apocservice,ou=services<base> ou=apocregistry sunkeyvalue` -[[!format txt """ -ldapsearch [-x] -h <host> -p <port> -b ou=apocregistry,ou=default,ou=organizationconfig,ou=1.0,ou=apocservice,ou=services<base> ou=apocregistry sunkeyvalue` -"""]] where <host>, <port>, and <base> match the values found in either the [[APOC Manager configuration|Apoc/Documentation/TroubleShooting]] or the [[APOC Agent configuration|Apoc/Documentation/TroubleShooting]]. The result of this search should be one entry with unreadable attributes (base 64 encoded values). The `-x` flag may be required or not depending on the version of `ldapsearch` used, try with it and remove it if a usage message is displayed. If no entry is found, that particular <base> on that particular <host> has not been prepared for use with APOC. Follow the instructions in the installation guide to run the deployment tool and prepare the LDAP server, please note that if the LDAP server uses non-standard attributes or object classes for its organisations, roles or users, or if users are not stored in `ou=People` containers, the file named [[OrganisationMapping|OrganisationMapping]] needs to be modified to reflect these differences *prior* to running the `deployApoc` or `createServiceTree` scripts. @@ -177,17 +175,17 @@ The current log level of the APOC Manager, which is actually the log level of th #### Enabling the APOC Agent To enable the APOC Agent you need to configure the policymgr.properties, file located in /usr/local/etc by default, here's an example of a basic anonymous configuration: -[[!format txt """ -#-----------------------------# -# Basic Configuration Example # -#-----------------------------# - -#PROVIDER_URL = ldap://server1.freedesktop.org:389/o=mySuffixDn -#AuthType=Anonymous -#AuthDn= -#Password= -#ConnectTimeout=1 -"""]] + + #-----------------------------# + # Basic Configuration Example # + #-----------------------------# + + #PROVIDER_URL = ldap://server1.freedesktop.org:389/o=mySuffixDn + #AuthType=Anonymous + #AuthDn= + #Password= + #ConnectTimeout=1 + <a name="ConfigureAPOCAgent"></a> #### Configuring the APOC Agent @@ -246,4 +244,4 @@ If the problem doesn't fit one of the above issues, or the tests and solutions o * a copy of the file named `policymgr.properties` located in `/opt/apoc/lib` for JDS 2 or `/etc/apoc` for JDS 3. * a copy of the file named `apocd.log.0` located in `/var/opt/apoc/Logs`. * on Linux only, a copy of the file named `messages` located in `/var/log`. - * for a RPM bassed Linux machine, the output of `rpm -qa | grep apoc`, for a Solaris one the output of `pkginfo | grep SUNWap`.
\ No newline at end of file + * for a RPM bassed Linux machine, the output of `rpm -qa | grep apoc`, for a Solaris one the output of `pkginfo | grep SUNWap`. diff --git a/Apoc/Downloads.mdwn b/Apoc/Downloads.mdwn index b0b9809..f1a8ac6 100644 --- a/Apoc/Downloads.mdwn +++ b/Apoc/Downloads.mdwn @@ -23,37 +23,33 @@ You will need to use the Git client to download the APOC source repository. If y #### SPI [[Browse the code|http://gitweb.freedesktop.org/?p=apoc-spi.git;a=tree]] or retrieve the git repository: -[[!format txt """ -$ git clone git://anongit.freedesktop.org/git/apoc-spi -"""]] + + $ git clone git://anongit.freedesktop.org/git/apoc-spi #### Agent [[Browse the code|http://gitweb.freedesktop.org/?p=apoc-agent.git;a=tree]] or retrieve the git repository: -[[!format txt """ -$ git clone git://anongit.freedesktop.org/git/apoc-agent -"""]] + + $ git clone git://anongit.freedesktop.org/git/apoc-agent #### Template Pacakges [[Browse the code|http://gitweb.freedesktop.org/?p=apoc-template-packages.git;a=tree]] or retrieve the git repository: -[[!format txt """ -$ git clone git://anongit.freedesktop.org/git/apoc-template-packages -"""]] + + $ git clone git://anongit.freedesktop.org/git/apoc-template-packages #### Profile Editor [[Browse the code|http://gitweb.freedesktop.org/?p=apoc-profile-editor.git;a=tree]] or retrieve the git repository: -[[!format txt """ -$ git clone git://anongit.freedesktop.org/git/apoc-profile-editor -"""]] + + $ git clone git://anongit.freedesktop.org/git/apoc-profile-editor #### Manager [[Browse the code|http://gitweb.freedesktop.org/?p=apoc-manager.git;a=tree]] or retrieve the git repository: -[[!format txt """ -$ git clone git://anongit.freedesktop.org/git/apoc-manager -"""]] + + $ git clone git://anongit.freedesktop.org/git/apoc-manager + (!) Once you have downloaded the source files, see [[building APOC from source|Apoc/Documentation/BuildingInstructions]]. @@ -63,9 +59,8 @@ $ git clone git://anongit.freedesktop.org/git/apoc-manager #### GConf Adapter The source code of the GConf APOC adapter is hosted in the GNOME subversion repository, run the following command to checkout the code: -[[!format txt """ -$ svn co http://svn.gnome.org/svn/gconf-apoc/trunk gconf-apoc -"""]] + + $ svn co http://svn.gnome.org/svn/gconf-apoc/trunk gconf-apoc ### Templates @@ -80,4 +75,4 @@ $ svn co http://svn.gnome.org/svn/gconf-apoc/trunk gconf-apoc #### Evolution -* [[Evolution 1.4 template package|http://apoc.freedesktop.org/downloads/templates/evolution_template_package1.4-0.tar.gz]].
\ No newline at end of file +* [[Evolution 1.4 template package|http://apoc.freedesktop.org/downloads/templates/evolution_template_package1.4-0.tar.gz]]. diff --git a/ApocDocumentation/TroubleShooting.mdwn b/ApocDocumentation/TroubleShooting.mdwn index 8525e4a..30695cb 100644 --- a/ApocDocumentation/TroubleShooting.mdwn +++ b/ApocDocumentation/TroubleShooting.mdwn @@ -89,10 +89,8 @@ To check that the LDAP server is running, run the command =ps -ef | grep slapd=. To ensure that the LDAP server has been properly setup, perform the following command: + ldapsearch [-x] -h <host> -p <port> -b ou=apocregistry,ou=default,ou=organizationconfig,ou=1.0,ou=apocservice,ou=services,<base> ou=apocregistry sunkeyvalue -[[!format txt """ -ldapsearch [-x] -h <host> -p <port> -b ou=apocregistry,ou=default,ou=organizationconfig,ou=1.0,ou=apocservice,ou=services,<base> ou=apocregistry sunkeyvalue -"""]] where <host>, <port>, and <base> match the values found in either the [[[#ConfigureAPOCMgr|[]][APOC Manager configuration]] or the [[[#ConfigureAPOCAgent|[]][APOC Agent configuration]]. The result of this search should be one entry with unreadable attributes (base 64 encoded values). The =-x= flag may be required or not depending on the version of =ldapsearch= used, try with it and remove it if a usage message is displayed. If no entry is found, that particular <base> on that particular <host> has not been prepared for use with APOC. Follow the instructions in the installation guide to run the deployment tool and prepare the LDAP server, please note that if the LDAP server uses non-standard attributes or object classes for its organisations, roles or users, or if users are not stored in =ou=People= containers, the file named OrganisationMapping needs to be modified to reflect these differences *prior* to running the =deployApoc= or =createServiceTree= scripts. @@ -101,10 +99,8 @@ Follow the instructions in the installation guide to run the deployment tool and To check whether a given user identified by its <username> exists in the LDAP server, run the following command from any machine: + ldapsearch [-x] -h <host> -p <port> -b <base> <attribute>=<username> dn -[[!format txt """ -ldapsearch [-x] -h <host> -p <port> -b <base> <attribute>=<username> dn -"""]] where <host>, <port>, and <base> match the values found in either the [[[#ConfigureAPOCMgr|[]][APOC Manager configuration]] or the [[[#ConfigureAPOCAgent|[]][APOC Agent configuration]], and <attribute> is the unique identifier attribute specified during the [[[#ConfigureLockhart|[]][Web Console configuration]] or found in the [[[#PrepareLDAP|[]][organisational mapping file]]. The =-x= flag may be required or not depending on the version of =ldapsearch= used, try with it and remove it if a usage message is displayed. If the above command returns =Cannot connect=, the LDAP server is [[[#StartLDAP|[]][not running]]. If it returns no entries, the user doesn't exist in the server or the attribute used is wrong. Add the user to the server and/or verify the [[[#ConfigureAPOCMgr|[]][APOC Manager configuration]] and the [[[#PrepareLDAP|[]][organisational mapping file]]. If it returns multiple entries, this means the attribute used doesn't uniquely identify a user in the LDAP server and this must be changed, either by using a different attribute or by modifying one of the duplicate entries. @@ -205,4 +201,4 @@ If the problem doesn't fit one of the above issues, or the tests and solutions o * a copy of the file named =policymgr.properties= located in =/opt/apoc/lib= for JDS 2 or =/etc/apoc= for JDS 3. * a copy of the file named =apocd.log.0= located in =/var/opt/apoc/Logs=. * on Linux only, a copy of the file named =messages= located in =/var/log=. - * for a Linux machine, the output of =rpm -qa | grep apoc=, for a Solaris one the output of =pkginfo | grep SUNWap=.
\ No newline at end of file + * for a Linux machine, the output of =rpm -qa | grep apoc=, for a Solaris one the output of =pkginfo | grep SUNWap=. |