You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,16 @@
1
1
# Installing OpenCms
2
2
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.
4
14
5
15
-[Install Java](#install-java)
6
16
-[Install Tomcat](#install-tomcat)
@@ -10,7 +20,9 @@ This guide provides step by step information on how to install OpenCms using Tom
10
20
-[Login to the OpenCms workplace](#login-to-the-opencms-workplace)
11
21
-[Security settings](#security-settings)
12
22
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
14
26
15
27
OpenCms supports Java 11 and Java 17.
16
28
@@ -22,7 +34,7 @@ Download and install Java, e.g., from one of the following repositories:
22
34
You must install a Java JDK (Java Development Kit), not a JRE (Java Runtime Environment).
23
35
Make sure that the `JAVA_HOME` environment variable points to your installed Java SDK and Java is working properly.
24
36
25
-
## Install Tomcat
37
+
###Install Tomcat
26
38
27
39
OpenCms supports Tomcat 9.x and 8.x.
28
40
@@ -35,7 +47,7 @@ If you run a purely headless Linux system, image processing will not work and To
35
47
36
48
Start Tomcat and make sure it is running properly.
37
49
38
-
## Install MariaDB/MySQL
50
+
###Install MariaDB/MySQL
39
51
40
52
OpenCms supports MariaDB/MySQL 5.5 and later.
41
53
@@ -44,11 +56,11 @@ Download and install MariaDB from [https://mariadb.org/download/](https://mariad
44
56
Before running OpenCms you **must** update the datbase setting `max_allowed_packet` to `max_allowed_packet=32M` (or more).
45
57
You find this setting in the database configuration file, usually `my.cnf` on Unix systems or `my.ini` on Windows.
46
58
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/).
48
60
49
61
Start the database and make sure it is running properly.
50
62
51
-
## Download and deploy OpenCms
63
+
###Download and deploy OpenCms
52
64
53
65
Download the latest OpenCms distribution from [https://www.opencms.org/en/download/](https://www.opencms.org/en/download/).
54
66
Unpack the distribution ZIP file.
@@ -62,15 +74,15 @@ Make sure Tomcat does unpack the war file and creates the `{CATALINA_HOME}/webap
62
74
The default configuration for your Servlet container may be to not unpack the deployed `*.war` file.
63
75
If this is the case, you must unpack the `opencms.war` file manually.
64
76
65
-
## Follow the setup wizard
77
+
###Follow the setup wizard
66
78
67
79
Start the setup wizard by pointing your browser to `http://localhost:8080/opencms/setup/`.
68
80
Follow the instructions of the OpenCms setup wizard.
69
81
For normal installations with MariaDB/MySQL and Tomcat running on the same server, all default settings will be fine.
70
82
71
83
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/).
72
84
73
-
## Login to the OpenCms workplace
85
+
###Login to the OpenCms workplace
74
86
75
87
Your OpenCms installation is now ready to use.
76
88
@@ -80,14 +92,12 @@ You can login with username `Admin` and password `admin`.
80
92
Make sure you disable all pop-up blockers and enable Javascript for your OpenCms server URL.
81
93
Otherwise you may not be able to log in.
82
94
83
-
## Security settings
95
+
###Security settings
84
96
85
97
After your OpenCms is running you definitely should change the default passwords!
86
98
87
99
To change the `Admin` user password of OpenCms, first login to the OpenCms workplace using the default password `admin`.
88
100
Then click on the user icon on the top right, and select *Change password* in the drop down menu.
89
101
90
102
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.
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,9 +75,9 @@ Receive updates about the OpenCms development and get in touch with the core dev
75
75
76
76
## Compatibility
77
77
78
-
OpenCms 18 is compatible with Java 21, 17, and 11.
78
+
OpenCms is compatible with Java 21, 17, and 11.
79
79
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.
81
81
82
82
On the database side, we provide support for MySQL, MariaDB, Oracle, PostgreSQL, MS SQL Server, DB2 and HSQLDB.
0 commit comments