Repository: any23 Updated Branches: refs/heads/master ef7826df5 -> bf5fea3aa
ANY23-373 fix install page by piping through Velocity Project: http://git-wip-us.apache.org/repos/asf/any23/repo Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/bf5fea3a Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/bf5fea3a Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/bf5fea3a Branch: refs/heads/master Commit: bf5fea3aa8bfca49b893e662a94bbde4ca8d4d2a Parents: ef7826d Author: Hans <[email protected]> Authored: Fri Aug 17 14:17:36 2018 -0500 Committer: Hans <[email protected]> Committed: Fri Aug 17 14:17:36 2018 -0500 ---------------------------------------------------------------------- src/site/apt/install.apt | 153 --------------------------------------- src/site/apt/install.apt.vm | 153 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 153 insertions(+), 153 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/any23/blob/bf5fea3a/src/site/apt/install.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/install.apt b/src/site/apt/install.apt deleted file mode 100644 index 4551935..0000000 --- a/src/site/apt/install.apt +++ /dev/null @@ -1,153 +0,0 @@ - ------ - Apache Any23 - Installation Guide - ------ - The Apache Software Foundation - ------ - 2011-2012 - -~~ Licensed to the Apache Software Foundation (ASF) under one or more -~~ contributor license agreements. See the NOTICE file distributed with -~~ this work for additional information regarding copyright ownership. -~~ The ASF licenses this file to You under the Apache License, Version 2.0 -~~ (the "License"); you may not use this file except in compliance with -~~ the License. You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -Apache Any23 Installation Guide - - This page describes how to install <<Apache Any23>>. - -* Download a Stable Distribution - - Most users probably don't need to have day to day access to the source code as it changes. - For these users we provide distribution packages via our {{{./download.html} - downloads page}}. Download either the <<".zip">> or <<".tar.gz">> file and extract the archive. - -Installing the Core - -* Windows 2000/XP - - [[1]] Unzip the distribution archive, i.e. <<<apache-any23-${project.version}-bin.zip>>> to the directory you wish to - install Apache Any23 ${project.version}. - These instructions assume you chose <<<C:\Program Files\Apache Software Foundation>>>. - The subdirectory <<<apache-any23-${project.version}>>> will be created from the archive. - - [[2]] Add the <<<ANY23_HOME>>> environment variable by opening up the system properties (WinKey + Pause), - selecting the "Advanced" tab, and the "Environment Variables" button, then adding the <<<ANY23_HOME>>> - variable in the user variables with the value - <<<C:\Program Files\Apache Software Foundation\apache-any23-${project.version}>>>. - - [[3]] In the same dialog, add the <<<ANY23>>> environment variable in the user variables with the value <<<%ANY23_HOME%\bin>>>. - - [[4]] Optional: In the same dialog, add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable in the user variables to specify - JVM properties, e.g. the value <<<-Xms256m -Xmx512m>>>. This environment variable can be used to supply extra options. - By default, it is set to: <<<-Xms500m -Xmx500m -XX:PermSize=128m -XX:-UseGCOverheadLimit>>>. - - [[5]] In the same dialog, update/create the Path environment variable in the user variables and prepend the value - <<<%ANY23%>>> to add Apache Any23 available in the command line. - - [[6]] In the same dialog, make sure that <<<JAVA_HOME>>> exists in your user variables or in the system variables and it is - set to the location of your JDK, e.g. <<<C:\Program Files\Java\jdk1.5.0_02>>> and that <<<%JAVA_HOME%\bin>>> is in your Path - environment variable. - - [[7]] Open a new command prompt (Winkey + R then type cmd) and run <<<any23 --version>>> to verify that it is correctly installed. - -* Unix-based Operating Systems (Linux, Solaris and Mac OS X) - - [[1]] Extract the distribution archive, i.e. <<<apache-any23-${project.version}-bin.tar.gz>>> to the directory you wish to - install Apache Any23 ${project.version}. - These instructions assume you chose <<</usr/local/apache-any23>>>. - The subdirectory <<<apache-any23-${project.version}>>> will be created from the archive. - - [[2]] In a command terminal, add the <<<ANY23_HOME>>> environment variable, e.g. - <<<export ANY23_HOME=/usr/local/apache-any23/apache-any23-${project.version}>>>. - - [[3]] Add the <<<ANY23>>> environment variable, e.g. <<<export ANY23=$ANY23_HOME/bin>>>. - - [[4]] Optional: Add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable to specify JVM properties, e.g. - <<<export EXTRA_JVM_ARGUMENTS="-Xms256m -Xmx512m">>>. - This environment variable can be used to supply extra options. - - [[5]] Add M2 environment variable to your path, e.g. <<<export PATH=$ANY23:$PATH>>>. - - [[6]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, e.g. - <<<export JAVA_HOME=/usr/java/jdk1.5.0_02>>> and that <<<$JAVA_HOME/bin>>> is in your PATH environment variable. - - [[7]] Run <<<any23 --version>>> to verify that it is correctly installed. - -Installing a plugin - -* Windows 2000/XP - - [[1]] Unzip the distribution archive, i.e. <<<apache-${plugin.name}-bin.zip>>> - The subdirectory <<<apache-${plugin.name}>>> will be created from the archive. - - [[2]] Copy the jar files under <<<C:\Documents and Settings\<username>\.any23\plugins>>> - -* Unix-based Operating Systems (Linux, Solaris and Mac OS X) - - [[1]] Extract the distribution archive, i.e. <<<apache-${plugin.name}-bin.tar.gz>>>. - The subdirectory <<<apache-${plugin.name}>>> will be created from the archive. - - [[2]] Copy the jar files under <<<~/.any23/plugins>>> - -Installing the service - -* Installing the standalone server - -** Windows 2000/XP - - [[1]] Unzip the distribution archive, i.e. <<<apache-any23-service-${project.version}-bin-server-embedded.zip>>> to the directory you wish to - install Apache Any23 ${project.version}. - These instructions assume you chose <<<C:\Program Files\Apache Software Foundation>>>. - The subdirectory <<<apache-${project.version}-server-embedded>>> will be created from the archive. - - [[2]] Add the <<<ANY23_HOME>>> environment variable by opening up the system properties (WinKey + Pause), - selecting the "Advanced" tab, and the "Environment Variables" button, then adding the <<<ANY23_HOME>>> - variable in the user variables with the value - <<<C:\Program Files\Apache Software Foundation\apache-${project.version}>>>. - - [[3]] In the same dialog, add the <<<ANY23>>> environment variable in the user variables with the value <<<%ANY23_HOME%\bin>>>. - - [[4]] Optional: In the same dialog, add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable in the user variables to specify - JVM properties, e.g. the value <<<-Xms256m -Xmx512m>>>. This environment variable can be used to supply extra options. - By default, it is set to: <<<-Xms500m -Xmx500m -XX:PermSize=128m -XX:-UseGCOverheadLimit>>>. - - [[5]] In the same dialog, update/create the Path environment variable in the user variables and prepend the value - <<<%ANY23%>>> to add Apache Any23 available in the command line. - - [[6]] In the same dialog, make sure that <<<JAVA_HOME>>> exists in your user variables or in the system variables and it is - set to the location of your JDK, e.g. <<<C:\Program Files\Java\jdk1.5.0_02>>> and that <<<%JAVA_HOME%\bin>>> is in your Path - environment variable. - - [[7]] Open a new command prompt (Winkey + R then type cmd) and run <<<any23server>>> to launch the service. - -** Unix-based Operating Systems (Linux, Solaris and Mac OS X) - - [[1]] Extract the distribution archive, i.e. <<<apache-${project.version}-bin-server-embedded.tar.gz>>> to the directory you wish to - install Apache Any23 ${project.version}. - These instructions assume you chose <<</usr/local/apache-any23>>>. - The subdirectory <<<apache-${project.version}-server-embedded>>> will be created from the archive. - - [[2]] In a command terminal, add the <<<ANY23_HOME>>> environment variable, e.g. - <<<export ANY23_HOME=/usr/local/apache-any23/apache-${project.version}-server-embedded>>>. - - [[3]] Add the <<<ANY23>>> environment variable, e.g. <<<export ANY23=$ANY23_HOME/bin>>>. - - [[4]] Optional: Add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable to specify JVM properties, e.g. - <<<export EXTRA_JVM_ARGUMENTS="-Xms256m -Xmx512m">>>. - This environment variable can be used to supply extra options. - - [[5]] Add <<<ANY23>>> environment variable to your path, e.g. <<<export PATH=$ANY23:$PATH>>>. - - [[6]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, e.g. - <<<export JAVA_HOME=/usr/java/jdk1.5.0_02>>> and that <<<$JAVA_HOME/bin>>> is in your PATH environment variable. - - [[7]] Run <<<any23server>>> to launch the service. http://git-wip-us.apache.org/repos/asf/any23/blob/bf5fea3a/src/site/apt/install.apt.vm ---------------------------------------------------------------------- diff --git a/src/site/apt/install.apt.vm b/src/site/apt/install.apt.vm new file mode 100644 index 0000000..4551935 --- /dev/null +++ b/src/site/apt/install.apt.vm @@ -0,0 +1,153 @@ + ------ + Apache Any23 - Installation Guide + ------ + The Apache Software Foundation + ------ + 2011-2012 + +~~ Licensed to the Apache Software Foundation (ASF) under one or more +~~ contributor license agreements. See the NOTICE file distributed with +~~ this work for additional information regarding copyright ownership. +~~ The ASF licenses this file to You under the Apache License, Version 2.0 +~~ (the "License"); you may not use this file except in compliance with +~~ the License. You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, software +~~ distributed under the License is distributed on an "AS IS" BASIS, +~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +~~ See the License for the specific language governing permissions and +~~ limitations under the License. + +Apache Any23 Installation Guide + + This page describes how to install <<Apache Any23>>. + +* Download a Stable Distribution + + Most users probably don't need to have day to day access to the source code as it changes. + For these users we provide distribution packages via our {{{./download.html} + downloads page}}. Download either the <<".zip">> or <<".tar.gz">> file and extract the archive. + +Installing the Core + +* Windows 2000/XP + + [[1]] Unzip the distribution archive, i.e. <<<apache-any23-${project.version}-bin.zip>>> to the directory you wish to + install Apache Any23 ${project.version}. + These instructions assume you chose <<<C:\Program Files\Apache Software Foundation>>>. + The subdirectory <<<apache-any23-${project.version}>>> will be created from the archive. + + [[2]] Add the <<<ANY23_HOME>>> environment variable by opening up the system properties (WinKey + Pause), + selecting the "Advanced" tab, and the "Environment Variables" button, then adding the <<<ANY23_HOME>>> + variable in the user variables with the value + <<<C:\Program Files\Apache Software Foundation\apache-any23-${project.version}>>>. + + [[3]] In the same dialog, add the <<<ANY23>>> environment variable in the user variables with the value <<<%ANY23_HOME%\bin>>>. + + [[4]] Optional: In the same dialog, add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable in the user variables to specify + JVM properties, e.g. the value <<<-Xms256m -Xmx512m>>>. This environment variable can be used to supply extra options. + By default, it is set to: <<<-Xms500m -Xmx500m -XX:PermSize=128m -XX:-UseGCOverheadLimit>>>. + + [[5]] In the same dialog, update/create the Path environment variable in the user variables and prepend the value + <<<%ANY23%>>> to add Apache Any23 available in the command line. + + [[6]] In the same dialog, make sure that <<<JAVA_HOME>>> exists in your user variables or in the system variables and it is + set to the location of your JDK, e.g. <<<C:\Program Files\Java\jdk1.5.0_02>>> and that <<<%JAVA_HOME%\bin>>> is in your Path + environment variable. + + [[7]] Open a new command prompt (Winkey + R then type cmd) and run <<<any23 --version>>> to verify that it is correctly installed. + +* Unix-based Operating Systems (Linux, Solaris and Mac OS X) + + [[1]] Extract the distribution archive, i.e. <<<apache-any23-${project.version}-bin.tar.gz>>> to the directory you wish to + install Apache Any23 ${project.version}. + These instructions assume you chose <<</usr/local/apache-any23>>>. + The subdirectory <<<apache-any23-${project.version}>>> will be created from the archive. + + [[2]] In a command terminal, add the <<<ANY23_HOME>>> environment variable, e.g. + <<<export ANY23_HOME=/usr/local/apache-any23/apache-any23-${project.version}>>>. + + [[3]] Add the <<<ANY23>>> environment variable, e.g. <<<export ANY23=$ANY23_HOME/bin>>>. + + [[4]] Optional: Add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable to specify JVM properties, e.g. + <<<export EXTRA_JVM_ARGUMENTS="-Xms256m -Xmx512m">>>. + This environment variable can be used to supply extra options. + + [[5]] Add M2 environment variable to your path, e.g. <<<export PATH=$ANY23:$PATH>>>. + + [[6]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, e.g. + <<<export JAVA_HOME=/usr/java/jdk1.5.0_02>>> and that <<<$JAVA_HOME/bin>>> is in your PATH environment variable. + + [[7]] Run <<<any23 --version>>> to verify that it is correctly installed. + +Installing a plugin + +* Windows 2000/XP + + [[1]] Unzip the distribution archive, i.e. <<<apache-${plugin.name}-bin.zip>>> + The subdirectory <<<apache-${plugin.name}>>> will be created from the archive. + + [[2]] Copy the jar files under <<<C:\Documents and Settings\<username>\.any23\plugins>>> + +* Unix-based Operating Systems (Linux, Solaris and Mac OS X) + + [[1]] Extract the distribution archive, i.e. <<<apache-${plugin.name}-bin.tar.gz>>>. + The subdirectory <<<apache-${plugin.name}>>> will be created from the archive. + + [[2]] Copy the jar files under <<<~/.any23/plugins>>> + +Installing the service + +* Installing the standalone server + +** Windows 2000/XP + + [[1]] Unzip the distribution archive, i.e. <<<apache-any23-service-${project.version}-bin-server-embedded.zip>>> to the directory you wish to + install Apache Any23 ${project.version}. + These instructions assume you chose <<<C:\Program Files\Apache Software Foundation>>>. + The subdirectory <<<apache-${project.version}-server-embedded>>> will be created from the archive. + + [[2]] Add the <<<ANY23_HOME>>> environment variable by opening up the system properties (WinKey + Pause), + selecting the "Advanced" tab, and the "Environment Variables" button, then adding the <<<ANY23_HOME>>> + variable in the user variables with the value + <<<C:\Program Files\Apache Software Foundation\apache-${project.version}>>>. + + [[3]] In the same dialog, add the <<<ANY23>>> environment variable in the user variables with the value <<<%ANY23_HOME%\bin>>>. + + [[4]] Optional: In the same dialog, add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable in the user variables to specify + JVM properties, e.g. the value <<<-Xms256m -Xmx512m>>>. This environment variable can be used to supply extra options. + By default, it is set to: <<<-Xms500m -Xmx500m -XX:PermSize=128m -XX:-UseGCOverheadLimit>>>. + + [[5]] In the same dialog, update/create the Path environment variable in the user variables and prepend the value + <<<%ANY23%>>> to add Apache Any23 available in the command line. + + [[6]] In the same dialog, make sure that <<<JAVA_HOME>>> exists in your user variables or in the system variables and it is + set to the location of your JDK, e.g. <<<C:\Program Files\Java\jdk1.5.0_02>>> and that <<<%JAVA_HOME%\bin>>> is in your Path + environment variable. + + [[7]] Open a new command prompt (Winkey + R then type cmd) and run <<<any23server>>> to launch the service. + +** Unix-based Operating Systems (Linux, Solaris and Mac OS X) + + [[1]] Extract the distribution archive, i.e. <<<apache-${project.version}-bin-server-embedded.tar.gz>>> to the directory you wish to + install Apache Any23 ${project.version}. + These instructions assume you chose <<</usr/local/apache-any23>>>. + The subdirectory <<<apache-${project.version}-server-embedded>>> will be created from the archive. + + [[2]] In a command terminal, add the <<<ANY23_HOME>>> environment variable, e.g. + <<<export ANY23_HOME=/usr/local/apache-any23/apache-${project.version}-server-embedded>>>. + + [[3]] Add the <<<ANY23>>> environment variable, e.g. <<<export ANY23=$ANY23_HOME/bin>>>. + + [[4]] Optional: Add the <<<EXTRA_JVM_ARGUMENTS>>> environment variable to specify JVM properties, e.g. + <<<export EXTRA_JVM_ARGUMENTS="-Xms256m -Xmx512m">>>. + This environment variable can be used to supply extra options. + + [[5]] Add <<<ANY23>>> environment variable to your path, e.g. <<<export PATH=$ANY23:$PATH>>>. + + [[6]] Make sure that <<<JAVA_HOME>>> is set to the location of your JDK, e.g. + <<<export JAVA_HOME=/usr/java/jdk1.5.0_02>>> and that <<<$JAVA_HOME/bin>>> is in your PATH environment variable. + + [[7]] Run <<<any23server>>> to launch the service.
