egroupware/README.md

60 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

2016-05-12 18:08:44 +02:00
# EGroupware
2017-11-15 16:53:44 +01:00
| Tools | Usage |
| ----- | ----- |
| <img src="https://travis-ci.com/images/logos/TravisCI-Full-Color.png" width="108" alt="Travis CI"/> | runs unit-tests after each commit |
| [![Scrutinizer CI](https://scrutinizer-ci.com/images/logo.png) scrutinizer](https://scrutinizer-ci.com/g/EGroupware/egroupware/) | runs static analysis on our codebase |
| <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQ2scF5HUwLnJVnk2UhYwWpUXHmLQYNXM5yBw&usqp=CAU" width="110" alt="BrowserStack" /> | manual testing with unusual browser versions or platforms |
2016-05-12 18:08:44 +02:00
### Default and prefered installation method for EGroupware is via your Linux package manager:
2016-05-12 18:08:44 +02:00
* [Installation & Update instructions](https://github.com/EGroupware/egroupware/wiki/Installation-using-egroupware-docker-RPM-DEB-package)
* [Distribution specific instructions](https://github.com/EGroupware/egroupware/wiki/Distribution-specific-instructions)
2020-07-14 14:39:22 +02:00
> Every other method (including a developer installation by cloning the repo) is way more complicated AND does not include all features, as part's of EGroupware are running in different containers, eg. the push-server!
2024-06-27 06:20:46 +02:00
### Installing EGroupware 23.1 via Docker for non-Linux environments or not supported Linux distros:
EGroupware 23.1 can be installed via Docker, in fact the DEB/RPM packages also does that. Instructions on how to run EGroupware in Docker are in our [Wiki](https://github.com/EGroupware/egroupware/wiki/Docker-compose-installation) and in [doc/docker](https://github.com/EGroupware/egroupware/tree/23.1/doc/docker) subdirectory.
2016-06-27 17:03:57 +02:00
### Installing EGroupware development version via Docker:
* this is the prefered developer installation, as it contains eg. a push-server container
* https://github.com/EGroupware/egroupware/tree/master/doc/docker/development
### Deprecated EGroupware development installation:
2017-06-06 12:02:51 +02:00
* install composer.phar from https://getcomposer.org/download/
* for JavaScript dependencies and build install nodejs and npm
* optional: for minified CSS install grunt
2019-02-23 13:31:45 +01:00
```
apt/yum/zypper install nodejs
npm install -g grunt-cli
```
* install EGroupware and dependencies
```
cd /path/to/your/docroot
2019-02-24 11:27:38 +01:00
git clone https://github.com/EGroupware/egroupware.git # or git@github.com:EGroupware/egroupware.git for ssh
2019-02-23 13:31:45 +01:00
cd egroupware
./install-cli.php
```
* install non-default EGroupware apps by cloning them into your egroupware directory eg.
2019-02-23 13:31:45 +01:00
```
cd /path/to/your/egroupware
git clone https://github.com/EGroupware/wiki.git
2019-02-23 13:31:45 +01:00
```
2017-06-06 12:02:51 +02:00
* continue installation at http://localhost/egroupware/setup/
2019-02-23 13:31:45 +01:00
### Keeping EGroupware up to date or switch to release branch:
```
cd /path/to/your/egroupware
./install-cli.php [<change-channel>]
setup/setup-cli.php # will tell you if a schema-update is necessary
```
install-cli.php supports the following "channels":
2020-07-14 14:39:22 +02:00
- release: taged maintenance releases only eg. 19.1.20200701
- bugfix: release-branch incl. latest bugfixes eg. 20.1, if you are currently on 20.1.20200710
2019-02-23 13:31:45 +01:00
- \<branch\>: switch to given branch
- master: latest development for next release
2019-02-23 13:33:25 +01:00
To change the channel, call ```install-cli.php <channel-to-update-to>```.
2019-02-23 13:31:45 +01:00
For further instalation instructions see our wiki.