.github/README.md

   1 # Argeo Commons lightweight integration framework
   2
   3 Based on the OSGi and JCR standards. Enterprise-grade since 2009.
   4
   5 **The reference for Argeo code is http://git.argeo.org/ and this GitHub repository is a read-only mirror.**
   6
   7 ## Development
   8
   9 ### Pre-requisite
  10 - Java 11 OpenJDK (https://adoptopenjdk.net/)
  11 - Maven 3 (https://maven.apache.org/download.cgi)
  12 - Eclipse 2019-12 for RCP and RAP Developers (https://www.eclipse.org/downloads/packages/release/2019-12/r/eclipse-ide-rcp-and-rap-developers-includes-incubating-components)
  13
  14 ### First build, or after dependencies update
  15 ```bash
  16 mvn clean install argeo-osgi:pde-sources
  17 ```
  18
  19 This will download the sources of all third-party Java libraries in a format compatible with the Eclipse IDE, and will generate the Eclipse PDE target platform (Select ```org.argeo.dep.cms.e4.rap``` in Window > Preferences > Plug-in Development > Target Platform).
  20
  21 ### While developing
  22 ```bash
  23 mvn clean install
  24 ```
  25
  26 Fully functional SNAPSHOT RPMs can be built with (make sure your user has write access to /srv/rpmfactory):
  27 ```bash
  28 mvn clean install -Prpmbuild-tp,rpmbuild
  29 createrepo /srv/rpmfactory/argeo-osgi-2/el7/
  30 ```
  31
  32 ### Release
  33 ```bash
  34 mvn release:prepare
  35 mvn release:perform -Prpmbuild-tp,rpmbuild
  36 createrepo /srv/rpmfactory/argeo-osgi-2/el7/
  37 ```
  38
  39 ## Deployment
  40
  41 ### Pre-requisite
  42 - CentOS/RHEL 7 or 8
  43
  44 ### Install
  45 Please refer to the appropriate documentation for more complex deployments (e.g. LDAP server, PostgreSQL backend, etc.).
  46
  47 ```bash
  48 sudo yum install java-11-openjdk-headless
  49 sudo yum install argeo-node argeo-cms-e4-rap
  50 # Required only for local access to the OSGi console (telnet localhost 2323):
  51 sudo yum install telnet
  52 ```
  53
  54 Firewall
  55 ```bash
  56 sudo firewall-cmd --add-port 8080/tcp
  57 ```
  58
  59 ### Running with systemd
  60 ```bash
  61 systemctl [start|stop|restart] argeo
  62 # Make sure that the service is started after a server restart:
  63 systemctl enable argeo
  64 ```
  65
  66 The system is accessible via HTTP port 8080:
  67 http://localhost:8080/cms/devops
  68
  69 HTTP protection is configured on the reverse HTTP proxy. For example on Apache v2.4:
  70
  71 ```
  72 <IfModule mod_ssl.c>
  73 <VirtualHost <external IP address>:443>
  74   ServerName <external hostname>
  75   CustomLog logs/<external hostname>-access_log combined
  76   ErrorLog logs/<external hostname>-error_log
  77
  78   ProxyPreserveHost On
  79
  80   <Location / >
  81     ProxyPass http://<host on the local network>:8080/
  82     ProxyPassReverse http://<host on the local network>:8080/
  83   </Location>
  84
  85
  86 SSLCertificateFile <path to certificates>/cert.pem
  87 SSLCertificateKeyFile <path to certificates>/privkey.pem
  88 SSLCertificateChainFile <path to certificates>/chain.pem
  89 ...
  90
  91 </VirtualHost>
  92 </IfModule>
  93 ```
  94
  95 ### Log
  96 ```bash
  97 sudo tail -200f /var/log/messages
  98 ```