Skip to content

Commit 71b1a7d

Browse files
committed
Updating INSTALL and README.md for OpenCms 19.
1 parent f1bfd6b commit 71b1a7d

2 files changed

Lines changed: 24 additions & 14 deletions

File tree

INSTALL.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Installing OpenCms
22

3-
This guide provides step by step information on how to install OpenCms using Tomcat and MariaDB/MySQL.
3+
## Live demo server
4+
5+
If you just want to try OpenCms without doing a local installation, the easiest option is to use the [OpenCms Live Demo server](https://demo.opencms.org/). The live demo provides a personal OpenCms installation exclusively for you.
6+
7+
## Docker based Installation
8+
9+
**The easiest way to install OpenCms is to use the official docker image.** See [alkacon/opencms-docker](https://hub.docker.com/r/alkacon/opencms-docker/) on Docker Hub for full information about running the OpenCms docker image.
10+
11+
## Manual Installation
12+
13+
The following guide provides step by step information on how to install OpenCms "from scratch" manually on your local PC or on your server using Tomcat and MariaDB/MySQL.
414

515
- [Install Java](#install-java)
616
- [Install Tomcat](#install-tomcat)
@@ -10,7 +20,9 @@ This guide provides step by step information on how to install OpenCms using Tom
1020
- [Login to the OpenCms workplace](#login-to-the-opencms-workplace)
1121
- [Security settings](#security-settings)
1222

13-
## Install Java
23+
There is [additional documentation](https://documentation.opencms.org/opencms-documentation/server-administration/) available on deploying OpenCms in a production environment.
24+
25+
### Install Java
1426

1527
OpenCms supports Java 11 and Java 17.
1628

@@ -22,7 +34,7 @@ Download and install Java, e.g., from one of the following repositories:
2234
You must install a Java JDK (Java Development Kit), not a JRE (Java Runtime Environment).
2335
Make sure that the `JAVA_HOME` environment variable points to your installed Java SDK and Java is working properly.
2436

25-
## Install Tomcat
37+
### Install Tomcat
2638

2739
OpenCms supports Tomcat 9.x and 8.x.
2840

@@ -35,7 +47,7 @@ If you run a purely headless Linux system, image processing will not work and To
3547

3648
Start Tomcat and make sure it is running properly.
3749

38-
## Install MariaDB/MySQL
50+
### Install MariaDB/MySQL
3951

4052
OpenCms supports MariaDB/MySQL 5.5 and later.
4153

@@ -44,11 +56,11 @@ Download and install MariaDB from [https://mariadb.org/download/](https://mariad
4456
Before running OpenCms you **must** update the datbase setting `max_allowed_packet` to `max_allowed_packet=32M` (or more).
4557
You find this setting in the database configuration file, usually `my.cnf` on Unix systems or `my.ini` on Windows.
4658
This is required since OpenCms stores binary files such as images or PDF documents in the database.
47-
More information about database settings is available [here](https://documentation.opencms.org/opencms-documentation/server-installation/).
59+
More information about database settings is available [here](https://documentation.opencms.org/opencms-documentation/server-administration/database-settings/).
4860

4961
Start the database and make sure it is running properly.
5062

51-
## Download and deploy OpenCms
63+
### Download and deploy OpenCms
5264

5365
Download the latest OpenCms distribution from [https://www.opencms.org/en/download/](https://www.opencms.org/en/download/).
5466
Unpack the distribution ZIP file.
@@ -62,15 +74,15 @@ Make sure Tomcat does unpack the war file and creates the `{CATALINA_HOME}/webap
6274
The default configuration for your Servlet container may be to not unpack the deployed `*.war` file.
6375
If this is the case, you must unpack the `opencms.war` file manually.
6476

65-
## Follow the setup wizard
77+
### Follow the setup wizard
6678

6779
Start the setup wizard by pointing your browser to `http://localhost:8080/opencms/setup/`.
6880
Follow the instructions of the OpenCms setup wizard.
6981
For normal installations with MariaDB/MySQL and Tomcat running on the same server, all default settings will be fine.
7082

7183
A detailed explanation of the various setup wizard options is available in the [getting started guide](https://documentation.opencms.org/opencms-documentation/introduction/getting-started/).
7284

73-
## Login to the OpenCms workplace
85+
### Login to the OpenCms workplace
7486

7587
Your OpenCms installation is now ready to use.
7688

@@ -80,14 +92,12 @@ You can login with username `Admin` and password `admin`.
8092
Make sure you disable all pop-up blockers and enable Javascript for your OpenCms server URL.
8193
Otherwise you may not be able to log in.
8294

83-
## Security settings
95+
### Security settings
8496

8597
After your OpenCms is running you definitely should change the default passwords!
8698

8799
To change the `Admin` user password of OpenCms, first login to the OpenCms workplace using the default password `admin`.
88100
Then click on the user icon on the top right, and select *Change password* in the drop down menu.
89101

90102
You should also add a password for the OpenCms database connection.
91-
Please consult the documentation of your database for information about how to do so.
92-
93-
There is [additional documentation](https://documentation.opencms.org/opencms-documentation/server-installation/) available on deploying OpenCms in a production environment.
103+
Please consult the documentation of your database for information about how to do so.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ Receive updates about the OpenCms development and get in touch with the core dev
7575

7676
## Compatibility
7777

78-
OpenCms 18 is compatible with Java 21, 17, and 11.
78+
OpenCms is compatible with Java 21, 17, and 11.
7979

80-
OpenCms 18 requires a Java Servlet 4.0 compatible web container. We have tested this release using Jetty and Tomcat. It works "out of the box" with Jetty 12 or Tomcat 9. Others have reported deploying OpenCms successfully on other web servlet containers like WildFly, GlassFish, WebLogic, WebSphere and Resin.
80+
OpenCms requires a Java Servlet 4.0 compatible web container. We have tested this release using Jetty and Tomcat. It works "out of the box" with Jetty 12 or Tomcat 9. Others have reported deploying OpenCms successfully on other web servlet containers like WildFly, GlassFish, WebLogic, WebSphere and Resin.
8181

8282
On the database side, we provide support for MySQL, MariaDB, Oracle, PostgreSQL, MS SQL Server, DB2 and HSQLDB.
8383

0 commit comments

Comments
 (0)