credentials documented

src/site/apt/example-credentials.apt.vm

@@ -0,0 +1,65 @@
+ ------
+ With custom MySQL credentials
+ ------
+ Yegor Bugayenko
+ ------
+ 2014-01-23
+ ------
+
+~~
+~~ #set($sign="$")
+~~ Copyright (c) 2012-2013, JCabi.com
+~~ All rights reserved.
+~~
+~~ Redistribution and use in source and binary forms, with or without
+~~ modification, are permitted provided that the following conditions
+~~ are met: 1) Redistributions of source code must retain the above
+~~ copyright notice, this list of conditions and the following
+~~ disclaimer. 2) Redistributions in binary form must reproduce the above
+~~ copyright notice, this list of conditions and the following
+~~ disclaimer in the documentation and/or other materials provided
+~~ with the distribution. 3) Neither the name of the jcabi.com nor
+~~ the names of its contributors may be used to endorse or promote
+~~ products derived from this software without specific prior written
+~~ permission.
+~~
+~~ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+~~ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+~~ NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+~~ FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+~~ THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+~~ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+~~ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+~~ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+~~ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+~~ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+~~ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+~~ OF THE POSSIBILITY OF SUCH DAMAGE.
+~~
+
+With custom MySQL credentials
+
+  You can specify MySQL credentials, if you don't like the default
+  ones (database <<<root>>>, user <<<root>>> and password <<<root>>>), for example:
+
++--
+<project>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>com.jcabi</groupId>
+        <artifactId>jcabi-mysql-maven-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <port>${sign}{mysql.port}</port>
+          <data>${sign}{project.build.directory}/mysql-data</data>
+          <user>jeff</user>
+          <password>secret-6353</password>
+          <dbname>example</dbname>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  [...]
+</project>
++--

src/site/site.xml

@@ -59,6 +59,7 @@
         <menu name="Examples">
             <item name="Integration Testing" href="example-it.html"/>
             <item name="MySQL CLI Options" href="example-options.html"/>
+            <item name="Custom credentials" href="example-credentials.html"/>
         </menu>
         <menu ref="reports"/>
     </body>