aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 4d36ce9a96e78acf46227fb2c433c5df769be460 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
Apache Archiva
==============

Licensing information
=====================

Archiva is developed under the Apache License Version 2.0 

Please notice, the download distribution includes third party Java libraries that are not covered by Apache license, namely:
- Common Development and Distribution License (CDDL)
- Mozilla License
- Day Specification License


Archiva Development
===================

To get involved in Archiva development, contact dev@archiva.apache.org.

NOTE: you will need a `MAVEN_OPTS` with some memory setup as sample:  
`export MAVEN_OPTS="-Xmx768m -Xms768m -XX:MaxPermSize=256m"`

Running from Source Code
========================

As webapp js is in dev and won't probably be released soon, the module is not activated by default and it's included only in a profile
`mvn jetty:run -pl :archiva-webapp -am`  (to save fingers :-) use `sh ./jetty.sh` ) (debug with `sh ./jetty-debug.sh`, debug port is 8000)


hit your browser: http://localhost:9091/archiva/index.html

Test Registration email
========================
Redback can send email on registration. By default the mail jndi si configured to use localhost.
You can use your gmail accout for testing purpose.
In your **~/.m2/settings.xml** file add a property with a path to a tomcat context file:
```xml
<tomcatContextXml>/Users/olamy/dev/tomcat-context-archiva-gmail.xml</tomcatContextXml>
```
This file must contains:

```xml
<Context path="/archiva">
  <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"
            username="sa"
            password=""
            driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
            url="jdbc:derby:${catalina.base}/target/database/users;create=true"
  />
  <Resource name="mail/Session" auth="Container"
          type="javax.mail.Session"
          mail.smtp.host="smtp.gmail.com"
          mail.smtp.port="465"
          mail.smtp.auth="true"
          mail.smtp.user="your gmail account"
          password="your gmail password"
          mail.smtp.starttls.enable="true"
          mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"/>

</Context>
```

Using with cassandra as metadata storage
========================
You can run the application using cassandra as storage.

```shell
sh ./jetty.sh -Pcassandra
```

Default cassandra host is localhost and port 9160

You can override using:

 * `-Dcassandra.host=`
 * `-Dcassandra.port=`