add documentation for ui configuration

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1389883 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/archiva-docs/src/site/apt/adminguide/configuration.apt b/archiva-docs/src/site/apt/adminguide/configuration.apt
index a408abdd04052527835a0e2eac4ea4687f7b03bc..7a4438a1cab3f638f16135da47e3b2ffb28d315d 100644 (file)
--- a/archiva-docs/src/site/apt/adminguide/configuration.apt
+++ b/archiva-docs/src/site/apt/adminguide/configuration.apt
@@ -44,5 +44,7 @@ Runtime Configuration of Apache Archiva
 
     * {{{./appearance-configuration.html} Appearance configuration}}
 
+    * {{{./ui-configuration.html} UI configuration}}
+
     []
 

diff --git a/archiva-docs/src/site/apt/adminguide/ui-configuration.apt b/archiva-docs/src/site/apt/adminguide/ui-configuration.apt
new file mode 100644 (file)
index 0000000..bb8d977
--- /dev/null
+++ b/archiva-docs/src/site/apt/adminguide/ui-configuration.apt
@@ -0,0 +1,34 @@
+ ------
+ UI configuration
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Configuring your UI
+
+  By default when returning links (registration, artifacts download etc), localhost with current running port.
+
+  So if you are running Archiva behind an http server with a host that can be confusing for users.
+
+  The other option allows you to disable the register link.
+
+[../images/ui-configuration.png]
+

diff --git a/archiva-docs/src/site/resources/images/ui-configuration.png b/archiva-docs/src/site/resources/images/ui-configuration.png
new file mode 100644 (file)
index 0000000..c9cbfb5
Binary files /dev/null and b/archiva-docs/src/site/resources/images/ui-configuration.png differ

diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 290bae25f2962e3a0107c3792b7ae03a81e42755..81c753acb3cc04b218387534c510b910ea0d2915 100644 (file)
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -103,6 +103,7 @@
         <item name="Consumers"                href="/adminguide/consumers.html" />
         <item name="Staging Repositories"     href="/adminguide/staging-repositories.html"/>
         <item name="Appearance Configuration" href="/adminguide/appearance-configuration.html"/>
+        <item name="UI Configuration"         href="/adminguide/ui-configuration.html"/>
       </item>
       <item name="Web Services"              href="/adminguide/web-services.html" collapse="true">
         <item name="REST"                    href="/adminguide/webservices/rest.html"/>