From: Mathieu Baudier Date: Tue, 16 Jun 2020 08:47:53 +0000 (+0200) Subject: Create GitHub specific directory. X-Git-Tag: argeo-commons-2.1.89~127 X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=0da42aec05befdc9a183d288e2277fc46376cc9f;p=lgpl%2Fargeo-commons.git Create GitHub specific directory. --- diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 000000000..07fa9242f --- /dev/null +++ b/.github/README.md @@ -0,0 +1,98 @@ +# Argeo Commons lightweight integration framework + +Based on the OSGi and JCR standards. Enterprise-grade since 2009. + +**The reference for Argeo code is http://git.argeo.org/ ** (the GitHub mirrors are updated from time to time, usually after releases) + +## Development + +### Pre-requisite +- Java 11 OpenJDK (https://adoptopenjdk.net/) +- Maven 3 (https://maven.apache.org/download.cgi) +- 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) + +### First build, or after dependencies update +```bash +mvn clean install argeo-osgi:pde-sources +``` + +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). + +### While developing +```bash +mvn clean install +``` + +Fully functional SNAPSHOT RPMs can be built with (make sure your user has write access to /srv/rpmfactory): +```bash +mvn clean install -Prpmbuild-tp,rpmbuild +createrepo /srv/rpmfactory/argeo-osgi-2/el7/ +``` + +### Release +```bash +mvn release:prepare +mvn release:perform -Prpmbuild-tp,rpmbuild +createrepo /srv/rpmfactory/argeo-osgi-2/el7/ +``` + +## Deployment + +### Pre-requisite +- CentOS/RHEL 7 or 8 + +### Install +Please refer to the appropriate documentation for more complex deployments (e.g. LDAP server, PostgreSQL backend, etc.). + +```bash +sudo yum install java-11-openjdk-headless +sudo yum install argeo-node argeo-cms-e4-rap +# Required only for local access to the OSGi console (telnet localhost 2323): +sudo yum install telnet +``` + +Firewall +```bash +sudo firewall-cmd --add-port 8080/tcp +``` + +### Running with systemd +```bash +systemctl [start|stop|restart] argeo +# Make sure that the service is started after a server restart: +systemctl enable argeo +``` + +The system is accessible via HTTP port 8080: +http://localhost:8080/cms/devops + +HTTP protection is configured on the reverse HTTP proxy. For example on Apache v2.4: + +``` + +:443> + ServerName + CustomLog logs/-access_log combined + ErrorLog logs/-error_log + + ProxyPreserveHost On + + + ProxyPass http://:8080/ + ProxyPassReverse http://:8080/ + + + +SSLCertificateFile /cert.pem +SSLCertificateKeyFile /privkey.pem +SSLCertificateChainFile /chain.pem +... + + + +``` + +### Log +```bash +sudo tail -200f /var/log/messages +``` \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 07fa9242f..000000000 --- a/README.md +++ /dev/null @@ -1,98 +0,0 @@ -# Argeo Commons lightweight integration framework - -Based on the OSGi and JCR standards. Enterprise-grade since 2009. - -**The reference for Argeo code is http://git.argeo.org/ ** (the GitHub mirrors are updated from time to time, usually after releases) - -## Development - -### Pre-requisite -- Java 11 OpenJDK (https://adoptopenjdk.net/) -- Maven 3 (https://maven.apache.org/download.cgi) -- 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) - -### First build, or after dependencies update -```bash -mvn clean install argeo-osgi:pde-sources -``` - -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). - -### While developing -```bash -mvn clean install -``` - -Fully functional SNAPSHOT RPMs can be built with (make sure your user has write access to /srv/rpmfactory): -```bash -mvn clean install -Prpmbuild-tp,rpmbuild -createrepo /srv/rpmfactory/argeo-osgi-2/el7/ -``` - -### Release -```bash -mvn release:prepare -mvn release:perform -Prpmbuild-tp,rpmbuild -createrepo /srv/rpmfactory/argeo-osgi-2/el7/ -``` - -## Deployment - -### Pre-requisite -- CentOS/RHEL 7 or 8 - -### Install -Please refer to the appropriate documentation for more complex deployments (e.g. LDAP server, PostgreSQL backend, etc.). - -```bash -sudo yum install java-11-openjdk-headless -sudo yum install argeo-node argeo-cms-e4-rap -# Required only for local access to the OSGi console (telnet localhost 2323): -sudo yum install telnet -``` - -Firewall -```bash -sudo firewall-cmd --add-port 8080/tcp -``` - -### Running with systemd -```bash -systemctl [start|stop|restart] argeo -# Make sure that the service is started after a server restart: -systemctl enable argeo -``` - -The system is accessible via HTTP port 8080: -http://localhost:8080/cms/devops - -HTTP protection is configured on the reverse HTTP proxy. For example on Apache v2.4: - -``` - -:443> - ServerName - CustomLog logs/-access_log combined - ErrorLog logs/-error_log - - ProxyPreserveHost On - - - ProxyPass http://:8080/ - ProxyPassReverse http://:8080/ - - - -SSLCertificateFile /cert.pem -SSLCertificateKeyFile /privkey.pem -SSLCertificateChainFile /chain.pem -... - - - -``` - -### Log -```bash -sudo tail -200f /var/log/messages -``` \ No newline at end of file