Apache
/
archiva
mirror of https://github.com/apache/archiva.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

This commit is contained in:
Jozef Izso 2020-05-08 22:58:00 +02:00
parent ae41cf55fa
commit bc9cb84a95
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -17,29 +17,29 @@ Archiva Development
To get involved in Archiva development, contact dev@archiva.apache.org. To get involved in Archiva development, contact dev@archiva.apache.org.
NOTE: you will need a MAVEN_OPTS with some memory setup as sample : NOTE: you will need a `MAVEN_OPTS` with some memory setup as sample:
export MAVEN_OPTS="-Xmx768m -Xms768m -XX:MaxPermSize=256m" `export MAVEN_OPTS="-Xmx768m -Xms768m -XX:MaxPermSize=256m"`
Running from Source Code 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 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 8000) `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 hit your browser: http://localhost:9091/archiva/index.html
Test Registration email Test Registration email
======================== ========================
Redback can send email on registration by default the mail jndi si configured to use localhost. 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 You can use your gmail accout for testing purpose.
In your ~/.m2/settings.xml add a property with a path to a tomcat context file: 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> <tomcatContextXml>/Users/olamy/dev/tomcat-context-archiva-gmail.xml</tomcatContextXml>
``` ```
This file must contains: This file must contains:
``` ```xml
<Context path="/archiva"> <Context path="/archiva">
<Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource" <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"
username="sa" username="sa"
@ -63,14 +63,17 @@ This file must contains:
Using with cassandra as metadata storage Using with cassandra as metadata storage
======================== ========================
You can run the application using cassandra as storage. You can run the application using cassandra as storage.
```shell
sh ./jetty.sh -Pcassandra sh ./jetty.sh -Pcassandra
```
Default cassandra host is localhost and port 9160 Default cassandra host is localhost and port 9160
You can override using: You can override using:
* -Dcassandra.host= * `-Dcassandra.host=`
* -Dcassandra.port= * `-Dcassandra.port=`