aboutsummaryrefslogtreecommitdiffstats
path: root/archiva-docs/src/site/apt/adminguide/databases.apt
diff options
context:
space:
mode:
authorBrett Porter <brett@apache.org>2007-11-23 01:02:15 +0000
committerBrett Porter <brett@apache.org>2007-11-23 01:02:15 +0000
commit0cc815a3e821f0a77348b1326aa2c74510c7cd4f (patch)
tree26756b00edbcc01b0e6f3509d7402a0dc0efb576 /archiva-docs/src/site/apt/adminguide/databases.apt
parent06dd8b155cb227f4e14c4234f414aaa3b17fdfe4 (diff)
downloadarchiva-0cc815a3e821f0a77348b1326aa2c74510c7cd4f.tar.gz
archiva-0cc815a3e821f0a77348b1326aa2c74510c7cd4f.zip
commit some docs
git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597520 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'archiva-docs/src/site/apt/adminguide/databases.apt')
-rw-r--r--archiva-docs/src/site/apt/adminguide/databases.apt37
1 files changed, 34 insertions, 3 deletions
diff --git a/archiva-docs/src/site/apt/adminguide/databases.apt b/archiva-docs/src/site/apt/adminguide/databases.apt
index b1e001231..6898a327f 100644
--- a/archiva-docs/src/site/apt/adminguide/databases.apt
+++ b/archiva-docs/src/site/apt/adminguide/databases.apt
@@ -4,8 +4,39 @@
Apache Archiva Databases
- :STUB: This is a documentation stub.
+ Archiva uses an external database for two purposes:
-~~TODO: give general information on configuration for an external database
-~~TODO: use mysql or external derby as an example
+ * Storing artifact information
+
+ * As a default user store for security
+
+ []
+
+ Generally, it is unnecessary to configure anything - the built in embedded database is suitable for the artifact management, and if
+ an external authentication mechanism is not needed, the user database.
+
+ However, it is possible to configure an external database as needed.
+
+* Configuring an external database
+
+ Archiva uses JNDI data sources to locate the databases to use:
+
+ * <<<jdbc/archiva>>> - the repository database
+
+ * <<<jdbc/users>>> - the user store
+
+ Configuring an external database for either or both of these sources depends is configured in <<<plexus.xml>>> if you are using the
+ {{{standalone.html} standalone installation}}, or in the application server configuration if you are using the {{{webapp.html} web application
+ installation}}.
+
+* Backing up the database
+
+ While it is a good idea to back up both databases, it is not strictly necessary to back up the repository database on a regular basis. Should any
+ data loss be suffered, this database can be regenerated by deleting it's contents and re-scanning the repositories.
+
+ If you are using the default user security mechanism, it is important to back up the users database on a regular basis to ensure that the user
+ passwords and information are not lost in the event of corruption. With the default embedded storage this is simply a matter of making a copy of
+ the database directory on the filesystem. If you have configured an external database as the source for user information, please refer to your
+ database documentation for backup instructions.
+
~~TODO: link to wiki location that does others